Build Docs #22
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # action.yml | |
| name: 'Build Docs' | |
| on: | |
| push: | |
| branches: | |
| - main | |
| # - develop | |
| release: | |
| types: [published] | |
| jobs: | |
| build_docs: | |
| runs-on: ubuntu-latest | |
| name: 'Build Sphinx documentation' | |
| steps: | |
| - name: 'Checkout the repo' | |
| uses: actions/checkout@v4 | |
| - name: 'Run the buildscript' | |
| # Workaround to keep tty working | |
| # https://github.com/gfx/example-github-actions-with-tty | |
| shell: 'script -q -e -c "bash {0}"' | |
| run: ./docs/build-docs.sh ${{ fromJSON('{"tag":"html","branch":"html-dev"}')[github.ref_type] }} | |
| # Cache the build so we can deploy it | |
| - name: 'cache built docs' | |
| id: cache-build | |
| uses: actions/cache/save@v4 | |
| with: | |
| path: ${{ github.workspace }}/docs/build/html | |
| key: ${{ github.sha }}-docs | |
| # Cache version generation script if we are on a tag | |
| - name: 'cache version generation script' | |
| id: cache-version-script | |
| uses: actions/cache/save@v4 | |
| if: github.ref_type == 'tag' | |
| with: | |
| path: ${{ github.workspace }}/docs/generate_versions.sh | |
| key: ${{ github.sha }}-docs | |
| deploy_main_docs: | |
| permissions: | |
| contents: write | |
| pages: write | |
| runs-on: ubuntu-latest | |
| name: 'Publish latest docs to github pages' | |
| needs: build_docs | |
| if: github.ref_type == 'branch' && github.ref == 'refs/heads/main' | |
| steps: | |
| - name: 'Restore built docs cache' | |
| uses: actions/cache/restore@v4 | |
| id: restore-build | |
| with: | |
| path: ${{ github.workspace }}/docs/build/html | |
| key: ${{ github.sha }}-docs | |
| - name: 'Deploy to gh-pages' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build/html | |
| publish_branch: gh-pages | |
| destination_dir: dev | |
| deploy_version_docs: | |
| permissions: | |
| contents: write | |
| pages: write | |
| runs-on: ubuntu-latest | |
| name: 'Publish versioned documentation to github pages' | |
| needs: build_docs | |
| if: github.ref_type == 'tag' | |
| steps: | |
| - name: 'Checkout the repo' | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: gh-pages | |
| path: ./public | |
| - name: 'Get cached version script' | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/docs/generate_versions.sh | |
| key: ${{ github.sha }}-docs | |
| - name: 'Get cached version build' | |
| uses: actions/cache/restore@v4 | |
| with: | |
| path: ${{ github.workspace }}/docs/build/html | |
| key: ${{ github.sha }}-docs | |
| - name: 'Move file & directories & run version update script' | |
| shell: 'script -q -e -c "bash {0}"' | |
| run: > | |
| mv ./docs/generate_versions.sh ./public/generate_versions.sh | |
| && mv ./docs/build/html ./public/${{ github.ref_name }} | |
| && rm -rf ./docs/ | |
| && ./public/generate_versions.sh | |
| && rm -f ./public/generate_versions.sh | |
| - name: 'Update latest symlink and kill git' | |
| shell: 'script -q -e -c "bash {0}"' | |
| run: cd ./public/ && ln -sf ./${{ github.ref_name }} ./latest && rm -rf .git && ls -la | |
| - name: 'Deploy to gh-pages' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./public | |
| publish_branch: gh-pages | |
| # deploy_develop_docs: | |
| # permissions: | |
| # contents: write | |
| # pages: write | |
| # runs-on: ubuntu-latest | |
| # name: 'Publish development documentation to github pages' | |
| # needs: build_docs | |
| # if: endsWith(github.ref, '/develop') | |
| # steps: | |
| # - name: 'Restore built docs cache' | |
| # uses: actions/cache/restore@v3 | |
| # id: restore-build | |
| # with: | |
| # path: ${{ github.workspace }}/docs/build/html | |
| # key: ${{ github.sha }}-docs | |
| # - name: 'Deploy to gh-pages' | |
| # uses: peaceiris/actions-gh-pages@v3 | |
| # with: | |
| # github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # publish_dir: ./docs/build/html | |
| # publish_branch: gh-pages | |
| # destination_dir: develop | |
| # Probably not necesary with cache | |
| # cleanup: | |
| # runs-on: ubuntu-latest | |
| # needs: ['build_docs', 'deploy_main_docs', 'deploy_develop_docs'] | |
| # name: 'cache cleanup' | |
| # if: always() && needs.build_docs.result == 'success' | |
| # # Fun trick to say we need the above to all finish but only care about the first success | |
| # steps: | |
| # - uses: adapttive/[email protected] | |
| # with: | |
| # github-token: ${{ secrets.GITHUB_TOKEN }} | |
| # cache-key: ${{ github.sha }}-docs | |
| # TODO Versioned docs (look into the release event) |