Build Tutorials #12
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
| name: Build Tutorials | |
| on: | |
| push: | |
| branches: [ master ] | |
| tags: ["*"] | |
| pull_request: | |
| branches: [ master ] | |
| workflow_dispatch: | |
| inputs: | |
| run_deploy: | |
| description: 'Should newest tag be deployed?' | |
| required: false | |
| default: "" | |
| jobs: | |
| find-tag: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| latest-tag: ${{ steps.find-tag.outputs.tag }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - id: find-tag | |
| run: echo "tag=$(git describe --tags `git rev-list --tags --max-count=1`)" >> "$GITHUB_OUTPUT" | |
| link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: prefix-dev/[email protected] | |
| with: | |
| cache: true | |
| cache-write: ${{ github.event_name == 'push' && github.ref_name == 'master' }} | |
| - run: pixi run sphinx-build -M linkcheck . _build -W --keep-going -a -q | |
| link-check-last-tagged: | |
| runs-on: ubuntu-latest | |
| needs: find-tag | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ needs.find-tag.outputs.latest-tag }} | |
| - uses: prefix-dev/[email protected] | |
| continue-on-error: true | |
| id: pixisetup | |
| with: | |
| cache: true | |
| cache-write: ${{ github.event_name == 'push' && github.ref_name == 'master' }} | |
| - if: steps.pixisetup.outcome == 'success' | |
| run: pixi sphinx-build -M linkcheck . _build -W --keep-going -a -q | |
| - name: Install mamba | |
| if: steps.pixisetup.outcome == 'failure' | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: environment.yaml | |
| - name: build with mamba | |
| if: steps.pixisetup.outcome == 'failure' | |
| shell: bash -leo pipefail {0} {0} | |
| run: sphinx-build -M linkcheck . _build -W --keep-going -a -q | |
| build-latest: | |
| runs-on: ubuntu-latest | |
| needs: [find-tag, link-check] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: prefix-dev/[email protected] | |
| with: | |
| cache: true | |
| cache-write: ${{ github.event_name == 'push' && github.ref_name == 'master' }} | |
| - name: Build Documentation | |
| run: pixi run sphinx-build -M html . _build -W --keep-going -a -t draft | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: beta-version | |
| path: _build/html | |
| build-tagged: | |
| runs-on: ubuntu-latest | |
| needs: [find-tag, link-check] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ needs.find-tag.outputs.latest-tag }} | |
| fetch-depth: 0 | |
| - uses: prefix-dev/[email protected] | |
| continue-on-error: true | |
| id: pixisetup | |
| with: | |
| cache: true | |
| cache-write: ${{ github.event_name == 'push' && github.ref_name == 'master' }} | |
| - name: Build Documentation | |
| if: steps.pixisetup.outcome == 'success' | |
| run: pixi run sphinx-build -M html . _build -W --keep-going -a | |
| - name: Install mamba | |
| if: steps.pixisetup.outcome == 'failure' | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: environment.yaml | |
| - name: build with mamba | |
| if: steps.pixisetup.outcome == 'failure' | |
| shell: bash -leo pipefail {0} {0} | |
| run: sphinx-build -M html . _build -W --keep-going -a | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: tagged-version | |
| path: _build/html | |
| prepare-pages: | |
| needs: [build-latest, build-tagged] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/download-artifact@v3 | |
| with: | |
| name: tagged-version | |
| path: public | |
| - uses: actions/download-artifact@v3 | |
| with: | |
| name: beta-version | |
| path: public/beta | |
| - uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: public | |
| deploy: | |
| needs: prepare-pages | |
| if: github.ref == 'refs/heads/master' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 | |