Update design plan #24
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 docs to GitHub pages | |
| on: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| env: | |
| FORCE_COLOR: "1" | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| docs: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: laytan/setup-odin@v2 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| release: dev-2026-03 | |
| - name: Get commonmark | |
| run: sudo apt-get install libcmark-dev | |
| - name: Get and build Odin docs generator | |
| run: | | |
| mkdir -p tools | |
| # Clone to a temporary location outside the workspace to avoid confusion | |
| git clone https://github.com/odin-lang/pkg.odin-lang.org /home/runner/odin-doc | |
| cd /home/runner/odin-doc | |
| # Build renderer and place it in the workspace tools directory | |
| odin build . -out:$GITHUB_WORKSPACE/tools/odin-doc -o:speed | |
| - name: Generate documentation | |
| run: ./docs/generate.sh | |
| - uses: actions/configure-pages@v3 | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./docs/build | |
| - uses: actions/deploy-pages@v4 | |
| id: deployment |