Merge pull request #278 from QVerisAI/linfangw/docs-current-client-ve… #117
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 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" | |
| - "scripts/release-tag-version.mjs" | |
| - "scripts/sync-website-client-versions.mjs" | |
| - "scripts/sync-website-client-versions.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" | |
| - "scripts/release-tag-version.mjs" | |
| - "scripts/sync-website-client-versions.mjs" | |
| - "scripts/sync-website-client-versions.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@v7 | |
| 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 | |
| scripts/sync-website-client-versions.test.mjs |