如何将QAC/PRQA静态分析检查集成到Gitlab CI工作流
QAC/PRQA 集成 GitLab CI 实践方案
基础集成流程(GitLab CI 直连方案)
- 首先确保你的 GitLab Runner 环境已经安装好 QAC 客户端,并且完成了许可证激活,建议将 QAC 安装路径添加到系统环境变量,避免执行时找不到命令
- 在项目根目录下编写 QAC 分析配置文件
qac_project.conf,提前配置好需要检查的编码规则集、源码路径、排除路径等参数 - 编写
.gitlab-ci.yml,新增静态分析阶段的 job,示例配置如下:
stages: - static_analysis qac_check: stage: static_analysis tags: - qac-runner # 对应安装了QAC的Runner标签 script: # 初始化QAC项目 - qac init --config qac_project.conf # 执行全量分析,输出结果为json格式方便后续解析 - qac analyze --output qac_result.json --report-format json # 调用QAC自带的结果校验命令,错误数超过阈值直接返回非0退出码阻断流水线 - qac verify qac_result.json --error-threshold 0 --warning-threshold 10 artifacts: paths: - qac_result.json # 可选导出html报告留存 - qac_report.html when: always expire_in: 30 day
- 如果需要在 MR/PR 阶段触发检查,可在 job 规则中添加
only: [merge_requests]配置,实现提交代码自动触发 QAC 校验
接入 Jenkins 的可选方案
如果你们已经有现成的 Jenkins QAC 分析任务,可通过两种方式对接 GitLab CI:
- 方式1:在 GitLab CI job 中调用 Jenkins 接口触发 QAC 任务,轮询任务执行结果,根据返回结果控制流水线状态
- 方式2:直接将 QAC 分析阶段放在 Jenkins 中执行,通过 Jenkins 的 GitLab 插件将分析结果回调到 GitLab MR/PR 页面,同样可以实现代码合入阻断能力
常见问题处理
- 若 QAC 分析速度过慢,可开启增量分析模式,仅分析本次提交修改的文件,配置参数为
qac analyze --incremental - 如需将告警信息直接展示在 GitLab MR 的代码行上,可将 QAC 输出的结果转换为 GitLab 支持的 code quality 格式,再通过
reports: codequality字段上传即可 - 许可证数量不足的场景下,可配置规则仅对 master、release 等核心分支合入时执行全量 QAC 检查,普通开发分支仅做快速规则扫描
内容的提问来源于stack exchange,提问作者EagleOne
相关产品推荐
相关产品推荐

