yamldeeb25a2 | 1 | # Publish MkDocs site to GitHub Pages (project site: /cascade-ide/) |
| 2 | name docs-pages |
| 3 | |
| 4 | on |
| 5 | push: |
| 6 | branches: [develop, main] |
| 7 | paths: |
| 8 | - "docs/**" |
| 9 | - "mkdocs.yml" |
| 10 | - "requirements-docs.txt" |
| 11 | - "tools/gen_adr_pages.py" |
| 12 | - ".github/workflows/docs-pages.yml" |
| 13 | workflow_dispatch: |
| 14 | |
| 15 | permissions |
| 16 | contents: read |
| 17 | pages: write |
| 18 | id-token: write |
| 19 | |
| 20 | concurrency |
| 21 | group: docs-pages |
| 22 | cancel-in-progress: true |
| 23 | |
| 24 | jobs |
| 25 | build: |
| 26 | runs-on: ubuntu-latest |
| 27 | steps: |
| 28 | - uses: actions/checkout@v4 |
| 29 | |
| 30 | - uses: actions/setup-python@v5 |
| 31 | with: |
| 32 | python-version: "3.12" |
| 33 | cache: pip |
| 34 | cache-dependency-path: requirements-docs.txt |
| 35 | |
| 36 | - name: Install MkDocs |
| 37 | run: pip install -r requirements-docs.txt |
| 38 | |
| 39 | - name: Generate ADR navigator pages |
| 40 | run: python tools/gen_adr_pages.py |
| 41 | |
| 42 | - name: Build site |
| 43 | run: mkdocs build |
| 44 | |
| 45 | - uses: actions/upload-pages-artifact@v3 |
| 46 | with: |
| 47 | path: site |
| 48 | |
| 49 | deploy: |
| 50 | needs: build |
| 51 | runs-on: ubuntu-latest |
| 52 | environment: |
| 53 | name: github-pages |
| 54 | url: ${{ steps.deployment.outputs.page_url }} |
| 55 | steps: |
| 56 | - id: deployment |
| 57 | uses: actions/deploy-pages@v4 |
| 58 | |
View only · write via MCP/CIDE