qveris-agent-toolkit/.github/workflows/docs-check.yml at 1da4c1306191dd7dc6aaa2cf3ed36cef88d55f20 · QVerisAI/qveris-agent-toolkit · 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
name: Docs checks

# Guard the docs locale structure (en-US / zh-CN / cn/zh-CN) against silent
# drift. See #162 and scripts/check-doc-locales.mjs.

on:
  pull_request:
    paths:
      - "docs/en-US/**"
      - "docs/zh-CN/**"
      - "docs/cn/**"
      - "packages/js-sdk/src/**"
      - "packages/js-sdk/docs-api/**"
      - "packages/js-sdk/typedoc.json"
      - "packages/js-sdk/package.json"
      - "packages/js-sdk/package-lock.json"
      - "packages/python-sdk/qveris/**"
      - "packages/python-sdk/docs-api/**"
      - "packages/python-sdk/pyproject.toml"
      - "packages/python-sdk/uv.lock"
      - "scripts/check-doc-locales.mjs"
      - "scripts/prepare-website-docs.mjs"
      - "scripts/prepare-website-docs.test.mjs"
      - ".github/workflows/docs-check.yml"
      - ".github/workflows/sync-docs-to-website.yml"
  push:
    branches:
      - main
    paths:
      - "docs/en-US/**"
      - "docs/zh-CN/**"
      - "docs/cn/**"
      - "packages/js-sdk/src/**"
      - "packages/js-sdk/docs-api/**"
      - "packages/js-sdk/typedoc.json"
      - "packages/js-sdk/package.json"
      - "packages/js-sdk/package-lock.json"
      - "packages/python-sdk/qveris/**"
      - "packages/python-sdk/docs-api/**"
      - "packages/python-sdk/pyproject.toml"
      - "packages/python-sdk/uv.lock"
      - "scripts/check-doc-locales.mjs"
      - "scripts/prepare-website-docs.mjs"
      - "scripts/prepare-website-docs.test.mjs"
      - ".github/workflows/docs-check.yml"
      - ".github/workflows/sync-docs-to-website.yml"

permissions:
  contents: read

jobs:
  api-reference:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: 20
          cache: "npm"
          cache-dependency-path: packages/js-sdk/package-lock.json
      - uses: actions/setup-python@v6
        with:
          python-version: "3.11"
      - uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true
          cache-dependency-glob: packages/python-sdk/uv.lock
      - name: Generate TypeScript API reference
        working-directory: packages/js-sdk
        run: npm ci && npm run docs:generate
      - name: Generate Python API reference
        working-directory: packages/python-sdk
        run: uv run --extra dev python docs-api/generate.py
      - name: Check generated reference drift
        run: git diff --exit-code -- docs/en-US/js-sdk-api.md docs/zh-CN/js-sdk-api.md docs/en-US/python-sdk-api.md docs/zh-CN/python-sdk-api.md

  locales:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: 20
      - name: Check doc locale consistency
        run: node scripts/check-doc-locales.mjs
      - name: Test release-aware website docs staging
        run: node --test scripts/prepare-website-docs.test.mjs