LocalSetup/.github/workflows/docs-sync.yml at main · CruxExperts/LocalSetup · 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
name: docs-sync

on:
  workflow_call:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  verify-generated-docs:
    name: generated docs drift
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0
          ref: ${{ github.event.pull_request.head.sha || github.sha }}

      - name: Setup Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.12"

      - name: Setup uv
        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
        with:
          version: "0.11.21"
          prune-cache: true

      - name: Sync dependencies
        run: uv sync --frozen --all-groups --python python3

      - name: Regenerate docs artifacts
        run: |
          uv run --frozen python ls/tools/generate_docs_artifacts.py --repo-root .
          uv run --frozen python ls/tools/localsetup.py --source-root . generate-docs
          uv run --frozen python ls/tools/localsetup.py --source-root . version-sync --check --target "$(cat VERSION)"

      - name: Validate product branding
        run: uv run --frozen python ls/tools/validate_branding.py --repo-root . --strict

      - name: Check release highlights and guides
        run: uv run --frozen python ls/tools/localsetup.py --source-root . release-docs check

      - name: Check documentation alignment
        run: |
          set +e
          uv run --frozen python ls/tools/docs_alignment.py --repo-root . check --ci --summary-output /tmp/docs-alignment-summary.md
          status=$?
          set -e
          cat /tmp/docs-alignment-summary.md >> "$GITHUB_STEP_SUMMARY"
          exit "$status"

      - name: Verify generated files are committed
        run: git diff --exit-code