Garde-fou qualité en CI

Combine check, coverage et lint dans un seul job pour faire échouer les PR qui dégradent la documentation.

Exemple de job

.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 échoue si un contrôleur marqué avec @WithDocs() n'a pas de fichier compagnon ou a gagné des méthodes depuis le dernier generate. coverage --min 90 fait échouer le build si moins de 90 % des endpoints sont documentés. lint juge la qualité de ce qui est déjà documenté : summary manquant sur ApiOperation, endpoints avec @Body() et sans réponse 400, et ApiBody sans description. Chacune des trois commandes sort avec le code 1 quand elle trouve des problèmes, ce qui fait échouer le pipeline.

À quoi ressemble un échec

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.

En tant que scripts npm

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