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
yaml
- name: Docs quality gate
run: |
npx nestjs-docfy check
npx nestjs-docfy coverage --min 90
npx nestjs-docfy lintcheck 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.