首页/开发/代码质量与评审速查/检查结果在审查中的呈现
规范与静态检查65 条

检查结果在审查中的呈现

让告警贴着改动出现:CI 以文件与行号注释(annotation)、SARIF 或评论机器人输出到 diff 页,再由审查者判断是否阻断,减少上下文切换。

形式行内 annotation / 检查摘要 / PR 评论
工具GitHub Actions、GitLab Code Quality、SARIF 兼容工具
策略失败分级:error 阻断、warning 提示

GitLab 质量报告示例

GitLab 质量报告示例
lint:
  script:
    - ruff check --output-format=gitlab > gl-code-quality-report.json
  artifacts:
    reports:
      codequality: gl-code-quality-report.json
报告与门禁分开配置:先让结果可见,再逐步把高频真实问题升级为阻断。

易错点

  • 报告只在日志里:没人翻构建日志,告警长期无人处理
  • 一上来全量阻断:开发者只在报错时才关注检查,缺少渐进

数据来源与参考

  • GitLab 文档(Code Quality 报告)、GitHub Actions 文档(annotations)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌