Deploy MkDocs to GitHub Pages #22
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 MkDocs to GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - site | |
| repository_dispatch: | |
| types: [modules-updated] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout site branch | |
| uses: actions/checkout@v4 | |
| - name: Checkout master branch content | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: master | |
| path: master-content | |
| - name: Copy module content from master | |
| run: | | |
| # Copy README.md as index page | |
| cp master-content/README.md docs/index.md | |
| echo "Copied README.md -> docs/index.md" | |
| # Copy each module directory from master to docs/ | |
| for dir in master-content/mod-*/; do | |
| module=$(basename "$dir") | |
| rm -rf "docs/${module}" | |
| cp -r "$dir" "docs/" | |
| echo "Copied ${module}/" | |
| done | |
| # Clean up | |
| rm -rf master-content | |
| echo "=== Module files in docs/ ===" | |
| ls -la docs/mod-* | head -30 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install dependencies | |
| run: pip install -r requirements.txt | |
| - name: Update navigation from H1 titles | |
| run: python scripts/update_nav.py | |
| - name: Build site | |
| run: mkdocs build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./site | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |