progress-platform/.github/workflows/deploy-docs.yml at DEV · ProgressLabIT/progress-platform · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# .github/workflows/deploy-docs.yml
name: Deploy VitePress site to Pages

on:
  push:
    branches: [DEV]
    paths:
      - 'docs/**'
      - 'backend/api/endpoints/**'
      - 'backend/api/events/**'
      - 'backend/api/models/**'
      - 'backend/api/main.py'
      - 'backend/api/utils/config.py'
      - 'cli/**'
      - 'scripts/**'
      - 'tests/cli/**'
      - '.vacuum.yaml'
      - '.github/workflows/deploy-docs.yml'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment; do NOT cancel mid-flight (partial-deploy risk)
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 15   # L-01: bound runaway builds; current build is ~20s + npm install
    defaults:
      run:
        working-directory: docs
    steps:
      - name: Checkout
        uses: actions/checkout@v5
        with:
          fetch-depth: 0   # CP-9: VitePress lastUpdated needs full git history

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Install backend dependencies
        run: pip install -r backend/api/requirements.txt
        working-directory: ${{ github.workspace }}

      - name: Export OpenAPI schema (build-time introspection — no live app)
        run: python scripts/export_openapi.py
        working-directory: ${{ github.workspace }}

      - name: Extract event metadata (AST parse — no backend imports)
        run: python scripts/extract_events.py
        working-directory: ${{ github.workspace }}

      - name: Extract config metadata (AST parse — no backend imports)
        run: python scripts/extract_config.py
        working-directory: ${{ github.workspace }}

      - name: Check install.cast recording exists (warn if absent — recording produced at May 14 rehearsal)
        run: |
          if [ ! -s docs/public/recordings/install.cast ]; then
            echo "::warning file=docs/public/recordings/install.cast::install.cast is absent or empty. Run LAUNCH-CHECKLIST.md §3 (cloud-VM rehearsal) to capture and commit the recording before May 15."
          fi
        working-directory: ${{ github.workspace }}

      - name: Install pytest + typer for CLI drift gate
        run: pip install pytest typer
        working-directory: ${{ github.workspace }}

      - name: Validate CLI --help against doc snapshots (CLI-04 drift gate)
        run: pytest tests/cli/ -x
        working-directory: ${{ github.workspace }}

      - name: Setup Node
        uses: actions/setup-node@v6
        with:
          node-version: 20.19.0
          cache: npm
          cache-dependency-path: docs/package-lock.json

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Cache VitePress build
        uses: actions/cache@v4
        with:
          path: docs/.vitepress/cache
          key: vitepress-${{ runner.os }}-${{ hashFiles('docs/package-lock.json', 'docs/.vitepress/config.ts', 'docs/.vitepress/theme/**') }}
          restore-keys: |
            vitepress-${{ runner.os }}-

      - name: Install dependencies
        run: npm ci

      - name: Build with VitePress
        run: npm run docs:build

      - name: Install vacuum (descriptions-only OpenAPI lint gate — D-04)
        run: |
          VACUUM_VERSION="v0.26.4"
          VACUUM_SEMVER="${VACUUM_VERSION#v}"
          curl -fsSL "https://github.com/daveshanley/vacuum/releases/download/${VACUUM_VERSION}/vacuum_${VACUUM_SEMVER}_linux_x86_64.tar.gz" | tar xz
          sudo mv vacuum /usr/local/bin/vacuum
        working-directory: ${{ github.workspace }}

      - name: Lint OpenAPI schema (vacuum)
        run: vacuum lint docs/public/openapi.json --ruleset .vacuum.yaml --fail-severity error
        working-directory: ${{ github.workspace }}

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/.vitepress/dist

  deploy:
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 15   # L-01: bound runaway deploys
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4