🤖 fix: enable best-effort SSA create-on-update fallback #191
Workflow file for this run
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: Docs | |
| on: | |
| pull_request: | |
| paths: | |
| - docs/** | |
| - mkdocs.yml | |
| - .cspell.json | |
| - .markdownlint-cli2.yaml | |
| - .github/workflows/docs.yaml | |
| push: | |
| branches: [main] | |
| paths: | |
| - docs/** | |
| - mkdocs.yml | |
| - .cspell.json | |
| - .markdownlint-cli2.yaml | |
| - .github/workflows/docs.yaml | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: github-pages | |
| cancel-in-progress: false | |
| jobs: | |
| docs-quality: | |
| runs-on: depot-ubuntu-24.04 | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 | |
| with: | |
| persist-credentials: false | |
| - name: Set up Node.js | |
| uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0 | |
| with: | |
| node-version: '22' | |
| - name: Install docs lint tools | |
| run: npm install --global cspell@8.19.4 markdownlint-cli2@0.18.1 | |
| - name: Lint Markdown | |
| run: markdownlint-cli2 "docs/**/*.md" | |
| - name: Spell-check docs | |
| run: cspell --no-progress --config .cspell.json "docs/**/*.md" "mkdocs.yml" | |
| - name: Check links (including external) | |
| uses: lycheeverse/lychee-action@885c65f3dc543b57c898c8099f4e08c8afd178a2 # v2.6.1 | |
| with: | |
| fail: true | |
| args: >- | |
| --verbose | |
| --no-progress | |
| --accept 200,429 | |
| --max-retries 2 | |
| --retry-wait-time 2 | |
| --exclude '^https://github.com/coder/coder-k8s$' | |
| docs/*.md docs/*/*.md docs/*/*/*.md | |
| mkdocs.yml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| build: | |
| if: github.event_name == 'pull_request' | |
| needs: docs-quality | |
| runs-on: depot-ubuntu-24.04 | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 | |
| with: | |
| persist-credentials: false | |
| - name: Set up Python | |
| uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | |
| with: | |
| python-version: '3.x' | |
| cache: pip | |
| cache-dependency-path: docs/requirements.txt | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r docs/requirements.txt | |
| - name: Build docs (strict) | |
| run: mkdocs build --strict | |
| deploy: | |
| if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' | |
| needs: docs-quality | |
| runs-on: depot-ubuntu-24.04 | |
| timeout-minutes: 10 | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 | |
| with: | |
| persist-credentials: false | |
| - name: Set up Pages | |
| uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 | |
| - name: Set up Python | |
| uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | |
| with: | |
| python-version: '3.x' | |
| cache: pip | |
| cache-dependency-path: docs/requirements.txt | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r docs/requirements.txt | |
| - name: Build docs (strict) | |
| run: mkdocs build --strict | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | |
| with: | |
| path: site | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 |