spawnllm/.github/workflows/docs.yml at main · yasyf/spawnllm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# GENERATED by cc-guides from .claude/fragments/.github/workflows/docs.yml/ — do not edit; edit the fragments and push — CI renders.
name: Documentation

on:
  push:
    branches: [main]
  pull_request:

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build-docs:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0

      - name: Install uv
        uses: astral-sh/setup-uv@v8.2.0
        with:
          python-version: "3.13"
          cache-dependency-glob: uv.lock

      - name: Set up Quarto
        uses: quarto-dev/quarto-actions/setup@v2
        with:
          version: 1.9.38

      - name: Sync (docs)
        run: uv sync --group docs

      - name: Build documentation
        run: uv run --with "git+https://github.com/yasyf/cc-skills@main#subdirectory=tools/gd-build" gd-build build
        env:
          GITHUB_TOKEN: ${{ github.token }}

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v5
        with:
          path: great-docs/_site
          include-hidden-files: true

      # Warn-only docs quality gates (continue-on-error + per-step timeout = never gate the
      # deploy; publish-docs is a separate job). proofread omitted: needs harper-cli, absent in CI.
      - name: "Docs quality: API lint"
        run: uv run --group docs great-docs lint
        continue-on-error: true
        timeout-minutes: 2
        env:
          GITHUB_TOKEN: ${{ github.token }}

      - name: "Docs quality: link check"
        run: uv run --group docs great-docs check-links
        continue-on-error: true
        timeout-minutes: 3
        env:
          GITHUB_TOKEN: ${{ github.token }}

      - name: "Docs quality: SEO audit"
        run: uv run --group docs great-docs seo
        continue-on-error: true
        timeout-minutes: 2

  publish-docs:
    needs: build-docs
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5