集成StyleCop到Jenkins CI

时间:2024-01-20 11:35:57

这是集成完stylecop之后的Jenkins,可以看到code review结果随每个build变化的图表,Build History里面可以看到#150之前的build状态是unstable,这是和stylecop review出不符合要求的数目有关的:

集成StyleCop到Jenkins CI

1. 先安装StyleCop

2. 编辑你想要进行code review扫描的项目文件*.csproj:

集成StyleCop到Jenkins CI

好了,现在无论我们用IDE还是MSbuild进行构建的时候,都会进行stylecop的code review检查,默认会把所有检查出的结果置为build warnings。如果想要变为build errors,可以设置环境变量或build环境变量的StyleCopTreatErrorsAsWarnings为false,也可以编辑.csproj文件,在第一个 PropertyGroup section中加入StyleCopTreatErrorsAsWarnings tag并置为false:

集成StyleCop到Jenkins CI

3. 如果有第三方的代码或IDE自动产生的代码,则需要stylecop略过不进行扫描,有下面三种方法使其不进行code review:

  • 将文件后缀改为 “.Designer.cs”
  • 用C# region “generated code”括起来不想被review的代码
  • 把”//<auto-generated />”放到代码里面

4. Jenkins安装Jenkins Violations plugin插件:

集成StyleCop到Jenkins CI

5. 设置Jenkins Job开启Report Violations:

集成StyleCop到Jenkins CI

“XML filename pattern”需要指定编译项目后所产生的StyleCop的结果文件,这个文件默认是在项目的obj\Release\StyleCopViolations.xml,可以在build脚本中将其copy到jenkins的workspace根目录下。

好了,以后每次build都会产生Violations的报表了,还有详细的列表可以供开发人员查看:

集成StyleCop到Jenkins CI