Merge pull request #93 from Prescott-Data/chore/bump-0.2.6 #46
This file contains hidden or 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: Deploy Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - feat/doc-site-update | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - '.github/workflows/docs.yml' | |
| workflow_dispatch: # allow manual trigger from GitHub UI | |
| permissions: | |
| contents: read | |
| pages: write # deploy to GitHub Pages | |
| id-token: write # OIDC token for Pages deployment | |
| env: | |
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install MkDocs Material | |
| # Pin to MkDocs 1.x + Material 9.x — MkDocs 2.0 is incompatible with material theme | |
| run: pip install "mkdocs<2.0" "mkdocs-material<10" | |
| - name: Build site | |
| run: mkdocs build --clean | |
| - name: Upload Pages artifact | |
| # Only upload artifact when on main (Pages deploy only runs from main) | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: site/ | |
| deploy: | |
| # Only deploy to GitHub Pages from main | |
| if: github.ref == 'refs/heads/main' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |