API-Doc/.github/workflows/docs-quality.yml at main · LensmorOfficial/API-Doc · 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
name: Docs Quality

on:
  pull_request:
  push:
    branches:
      - main

permissions:
  contents: read

jobs:
  docs-quality:
    name: Docs Quality
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "22"

      - name: Run public asset tests
        run: python3 -m unittest scripts/test_sync_public_assets.py

      - name: Verify generated assets are current
        run: python3 scripts/sync-public-assets.py --check

      - name: Validate JSON and OpenAPI artifacts
        run: |
          jq empty docs.json api-catalog.json openapi.json api-reference/openapi.json api-reference-backup/openapi.json
          cmp -s openapi.json api-reference/openapi.json
          cmp -s openapi.json api-reference-backup/openapi.json

      - name: Reject legacy API key guidance
        run: |
          if rg -n 'uak_' README.md index.mdx authentication.mdx guides concepts llms.txt llms-full.txt openapi.json api-reference/openapi.json api-catalog.json scripts; then
            exit 1
          fi

      - name: Lint OpenAPI
        run: |
          redocly_output="$(npx --yes @redocly/cli@2.39.0 lint openapi.json --format json)"
          printf '%s\n' "$redocly_output"
          printf '%s\n' "$redocly_output" | jq -e '.totals.errors == 0 and .totals.warnings == 0'

  mintlify-deployment:
    name: Mintlify Deployment
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "22"

      - name: Validate Mintlify build
        run: npx --yes mintlify@4.2.740 validate