Deploy github pages #5
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 github pages | |
| on: | |
| # Artifact generation runs on all push events, but deploy only on main or when manually requested | |
| push: | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| inputs: | |
| deploy: | |
| description: "Force run the deploy step (ignore being on main)" | |
| default: false | |
| type: boolean | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Single deploy job since we're just deploying | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Install pip | |
| run: | | |
| python -m pip install -U pip | |
| python -m pip install -r requirements.txt | |
| - name: Install python dependencies | |
| run: python -m pip install tox pydot | |
| - name: Generate page content | |
| shell: bash -l {0} | |
| run: | | |
| cd docs | |
| jupyter-book build --html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/_build/html | |
| - name: Deploy to GitHub Pages | |
| if: ( github.ref == 'refs/heads/main' ) || ( github.event.inputs.deploy == 'true') | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |