Repository navigation
fix: address code review findings from Phase 1 stories #9
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
| # docs.yml — build and deploy mkdocs-material site to GitHub Pages. | |
| # | |
| # Uses the Actions-native Pages deployment pipeline (upload-pages-artifact + | |
| # deploy-pages), matching the repo's "build_type: workflow" Pages setting. | |
| # | |
| # Prerequisites (one-time, done in GitHub UI): | |
| # Settings → Pages → Source: GitHub Actions | |
| # | |
| # SHA → tag mappings verified via scripts/check-action-pins.sh. | |
| # actions/checkout fc324d35... → v4.2.2 (already in ci.yml) | |
| # actions/setup-go d35c59ab... → v5.5.0 (already in ci.yml) | |
| # actions/setup-python a26af69b... → v5.6.0 | |
| # upload-pages-artifact fc324d35... → v5.0.0 | |
| # deploy-pages cd2ce8fc... → v5.0.0 | |
| name: docs | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - 'cmd/gendocs/**' | |
| - 'internal/run/run.go' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 | |
| with: | |
| python-version: '3.x' | |
| - name: Install mkdocs-material | |
| run: pip install mkdocs-material | |
| - name: Generate CLI reference docs | |
| run: go run ./cmd/gendocs --out docs/reference | |
| - name: Build mkdocs site | |
| run: mkdocs build --strict | |
| - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 | |
| with: | |
| path: site/ | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0 |