Gate di qualità in CI

Combina check, coverage e lint in un unico job per far fallire le PR che degradano la documentazione.

Esempio di 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 fallisce se un controller marcato con @WithDocs() non ha un file companion o ha ottenuto metodi dall'ultimo generate. coverage --min 90 fa fallire la build se meno del 90% degli endpoint è documentato. lint giudica la qualità di ciò che è già documentato: summary mancante su ApiOperation, endpoint con @Body() e nessuna risposta 400, e ApiBody senza una description. Ognuno dei tre comandi esce con codice 1 quando trova problemi, il che fa fallire la pipeline.

Come appare un errore

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.

Come script npm

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