Repository navigation
Jupyter Book (via myst) GitHub Pages Deploy #327
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: Jupyter Book (via myst) GitHub Pages Deploy | |
| on: | |
| workflow_run: | |
| workflows: ["Auto-merge on Build Pass"] | |
| types: | |
| - completed | |
| branches: | |
| - 'claude/**' | |
| workflow_dispatch: | |
| env: | |
| BASE_URL: "/${{ github.event.repository.name }}" | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }} | |
| timeout-minutes: 20 | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| ref: main | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18.x | |
| # ✅ Add Python for notebook execution | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| cache: "pip" | |
| # ✅ Install Python deps needed by your notebooks | |
| - name: Install Python requirements | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| pip install pyyaml | |
| - name: Install MyST Markdown | |
| run: npm install -g mystmd | |
| - name: Replace commit hash in footer | |
| run: | | |
| COMMIT_SHA=$(git rev-parse --short HEAD) | |
| sed -i "s/COMMIT_HASH/${COMMIT_SHA}/g" footer.md | |
| - name: Build HTML Assets (execute) | |
| uses: nick-fields/retry@v3 | |
| with: | |
| timeout_minutes: 5 | |
| max_attempts: 3 | |
| retry_on: timeout | |
| command: myst build --execute --html | |
| - name: Generate Jupyter Notebooks | |
| run: python generate_notebooks.py | |
| - name: Generate Sitemap | |
| run: | | |
| python generate_sitemap.py | |
| env: | |
| BASE_URL_FULL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }} | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './_build/html' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |