Skip to content
play

GitHub Action

Build DocC Static Site

v1.0.3 Latest version

Build DocC Static Site

play

Build DocC Static Site

Build DocC Static Site

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Build DocC Static Site

uses: kiarashvosough1999/build-docC-static-site@v1.0.3

Learn more about this action in kiarashvosough1999/build-docC-static-site

Choose a version

Twitter Linkedin

Build DocC Static Site: Build Static Site From DocC Archive, Document Your Project Like A Professional On Github Action

Requirements

Platform Minimum Swift Tools Version Status
macOS 12.0+ 5.5 Tested

Usage

See action.yml.

Make sure to set the version to latest tag.

As An Example:

name: worksapce
on:
  push:
    branches:
      - '**'
jobs:
  build_docC:
    runs-on: macos-12
    steps:
    - name: checkout
      uses: actions/checkout@v3
      with:
       repository: ${{ github.event.pull_request.head.repo.full_name }}
       ref: ${{ github.event.pull_request.head.ref }}

    - name: build static site
      uses: actions/build-docC-static-site@v1.0.2

Integration With Github Pages Deployment

You can use docC-github-pages-deploy to deploy generated static site from docC to Github-Pages.

The default docC-generated-static-site-uploaded-name associated with docC-github-pages-deploy and docC-generated-static-site-zipped-upload-name associated with this action, input must be the same.

This action will zip the generated static site with gtar and tar extension. So do not specify the zip extension on either docC-generated-static-site-uploaded-name or docC-generated-static-site-zipped-upload-name.

Contributors

Feel free to share your ideas or any other problems. Pull requests are welcomed.

License

build-docC-static-site is released under an MIT license. See LICENSE for more information.