CI-Qualitätsgate

Kombiniere check, coverage und lint in einem einzigen Job, um PRs scheitern zu lassen, die die Dokumentation verschlechtern.

Beispiel-Job

yaml

- name: Docs quality gate
  run: |
    npx nestjs-docfy check
    npx nestjs-docfy coverage --min 90
    npx nestjs-docfy lint

check schlägt fehl, wenn ein mit @WithDocs() markierter Controller keine Companion-Datei hat oder seit dem letzten generate Methoden dazubekommen hat. coverage --min 90 lässt den Build scheitern, wenn weniger als 90 % der Endpunkte dokumentiert sind. lint beurteilt die Qualität dessen, was schon dokumentiert ist: fehlende Summary bei ApiOperation, Endpunkte mit @Body() und ohne 400-Antwort, und ApiBody ohne Beschreibung. Findet einer der drei Befehle Probleme, beendet er sich mit Code 1, was die Pipeline scheitern lässt.