CI 质量门禁

把 check、coverage 和 lint 组合进同一个任务，让文档质量下降的 PR 直接失败。

示例任务

.github/workflows/docs-quality.yml
# .github/workflows/docs-quality.yml
name: Docs quality gate
on: pull_request

jobs:
  docs-quality:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm
      - run: npm ci
      - name: Docs quality gate
        run: |
          npx nestjs-docfy check
          npx nestjs-docfy coverage --min 90
          npx nestjs-docfy lint

如果任何带 @WithDocs() 的控制器没有 companion 文件，或者自上次 generate 以来新增了方法，check 就会失败。coverage --min 90 会在文档化端点比例低于 90% 时让构建失败。lint 评判的是已有文档的质量：ApiOperation 缺少 summary、带 @Body() 却没有 400 响应的端点，以及没有描述的 ApiBody。这三个命令中任意一个发现问题都会以退出码 1 结束，导致流水线失败。

失败输出示例

npx nestjs-docfy check
✖ UsersController: undocumented methods: updateProfile, deleteAccount
  → run nestjs-docfy generate --force to merge new methods

✖ 2 controller(s) out of sync.
npx nestjs-docfy coverage --min 90
Controllers: 42
Endpoints: 187

Documented: 174
Missing docs: 13

Coverage: 93.0%
npx nestjs-docfy lint
✖ POST /users
  Missing 400 response

✖ GET /users
  Missing operation summary

✖ PATCH /users/:id
  Missing request body description

✖ 3 issue(s) found.

作为 npm 脚本

package.json
{
  "scripts": {
    "docs:check": "nestjs-docfy check",
    "docs:coverage": "nestjs-docfy coverage --min 90",
    "docs:lint": "nestjs-docfy lint"
  }
}