CI quality gate
Combine check, coverage, and lint into a single job to fail PRs that degrade documentation.
Example job
yaml
- name: Docs quality gate
run: |
npx nestjs-docfy check
npx nestjs-docfy coverage --min 90
npx nestjs-docfy lintcheck fails if any controller marked with @WithDocs() has no companion file or has methods added since the last generate. coverage --min 90 fails the build if fewer than 90% of endpoints are documented. lint judges the quality of what's already documented: missing summary on ApiOperation, endpoints with @Body() and no 400 response, and ApiBody without a description. Any of the three commands exits with code 1 when it finds problems, which fails the pipeline.