Bramka jakości w CI
Połącz check, coverage i lint w jedno zadanie, aby odrzucać PR-y pogarszające dokumentację.
Przykładowe zadanie
yaml
- name: Docs quality gate
run: |
npx nestjs-docfy check
npx nestjs-docfy coverage --min 90
npx nestjs-docfy lintcheck zawodzi, jeśli jakikolwiek kontroler oznaczony @WithDocs() nie ma pliku towarzyszącego albo zyskał metody od ostatniego generate. coverage --min 90 przerywa build, jeśli mniej niż 90% endpointów jest udokumentowanych. lint ocenia jakość tego, co już jest udokumentowane: brakujące summary w ApiOperation, endpointy z @Body() bez odpowiedzi 400 oraz ApiBody bez opisu. Każda z trzech komend kończy się kodem 1, gdy znajdzie problemy, co przerywa pipeline.