DocC Github Pages Deploy: Deploy Generated DocC Static Site To Github-Pages.

• Requirements
• Usage
• Integration
• Contributors
• License

Requirements

Platform	Status
ubuntu-latest	Tested

Usage

See action.yml.

Make sure to set the version to latest tag.

As An Example:

name: worksapce
on:
  push:
    branches:
      - '**'
jobs:
  build_deploy_site:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    permissions:
      pages: write
      contents: read
      id-token: write

    steps:
    - name: deploy static site
      uses: kiarashvosough1999/[email protected]

Make Sure give access to pages, contents and id-token, or the action will fail to push the site into Github-Pages.

Make sure to specify the name and url on the environment like the example, or the job will fail.

Integration With Build DocC Static Site

You can use build-docC-static-site to generate static site from DocC Archive.

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

This action will unzip the input 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

docC-github-pages-deploy is released under an MIT license. See LICENSE for more information.