Bramka jakości w CI

Połącz check, coverage i lint w jedno zadanie, aby odrzucać PR-y pogarszające dokumentację.

Przykładowe zadanie

.github/workflows/docs-quality.yml
# .github/workflows/docs-quality.yml
name: Docs quality gate
on: pull_request

jobs:
  docs-quality:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm
      - run: npm ci
      - name: Docs quality gate
        run: |
          npx nestjs-docfy check
          npx nestjs-docfy coverage --min 90
          npx nestjs-docfy lint

check zawodzi, jeśli jakikolwiek kontroler oznaczony @WithDocs() nie ma pliku towarzyszącego albo zyskał metody od ostatniego generate. coverage --min 90 przerywa build, jeśli mniej niż 90% endpointów jest udokumentowanych. lint ocenia jakość tego, co już jest udokumentowane: brakujące summary w ApiOperation, endpointy z @Body() bez odpowiedzi 400 oraz ApiBody bez opisu. Każda z trzech komend kończy się kodem 1, gdy znajdzie problemy, co przerywa pipeline.

Jak wygląda błąd

npx nestjs-docfy check
✖ UsersController: undocumented methods: updateProfile, deleteAccount
  → run nestjs-docfy generate --force to merge new methods

✖ 2 controller(s) out of sync.
npx nestjs-docfy coverage --min 90
Controllers: 42
Endpoints: 187

Documented: 174
Missing docs: 13

Coverage: 93.0%
npx nestjs-docfy lint
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

Jako skrypty npm

package.json
{
  "scripts": {
    "docs:check": "nestjs-docfy check",
    "docs:coverage": "nestjs-docfy coverage --min 90",
    "docs:lint": "nestjs-docfy lint"
  }
}