superdoc/.github/workflows/ci-document-api.yml at 739a18fe4ee3e05cff43102db123d26aa96438c5 · superdoc-dev/superdoc · 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
name: CI Document API

permissions:
  contents: read

on:
  pull_request:
    paths:
      - 'packages/document-api/**'
      - 'apps/docs/document-api/**'
      - 'package.json'
      - '.github/workflows/ci-document-api.yml'
  workflow_dispatch:

concurrency:
  group: ci-document-api-${{ github.event.pull_request.number || github.run_id }}
  cancel-in-progress: true

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: pnpm/action-setup@v4

      - uses: actions/setup-node@v4
        with:
          node-version-file: .nvmrc
          cache: pnpm

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Generate contract outputs
        run: pnpm run docapi:sync

      - name: Check overview.mdx freshness
        run: git diff --exit-code apps/docs/document-api/overview.mdx

      - name: Check contract parity and generated outputs
        run: pnpm run docapi:check