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