Merge pull request #149 from Astn/docs-site #2
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: Documentation site (GitHub Pages) | |
| on: | |
| push: | |
| branches: [ master ] | |
| paths: | |
| - "README.md" | |
| - "docs/**" | |
| - "site/**" | |
| - "AustinHarris.JsonRpc.AspNetCore/README.md" | |
| - "AustinHarris.JsonRpc.Newtonsoft/README.md" | |
| - "AustinHarris.JsonRpc.SystemTextJson/README.md" | |
| - "samples/WasmHost/README.md" | |
| - "benchmarks/Micro/README.md" | |
| - "benchmarks/charts/**" | |
| - ".github/workflows/pages.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v7 | |
| - uses: actions/setup-python@v7 | |
| with: | |
| python-version: "3.12" | |
| - uses: typst-community/setup-typst@v5 | |
| with: | |
| typst-version: "0.14.2" | |
| cache-dependency-path: site/page.typ | |
| - run: pip install pygments==2.19.2 | |
| # The committed charts must match the data: a stale chart or explorer fails the deploy. | |
| - name: Check the committed charts against the data | |
| run: python3 benchmarks/charts/render.py --check | |
| # Every documentation page is rendered from its Markdown source; a page that fails to compile fails here. | |
| - name: Build the site | |
| run: python3 site/build.py --out site/_out | |
| - uses: actions/configure-pages@v6 | |
| - uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: site/_out | |
| - id: deployment | |
| uses: actions/deploy-pages@v5 |