【转载】如何在JENKINS中配置CHECKSTYLE

转自:https://www.freesion.com/article/5029137304/

使用CheckStyle可以使团队开发的代码风格保持一致,是提升代码质量一个手段,本文将介绍如何在Jenkins中配置CheckStyle,以将相关的检查增加到持续集成流程中。

在JENKINS中安装CHECKSTYLE插件

Jenkins中CheckStyle插件的作用是图形化的展示CheckStyle输出的结果,可以在Jenkins > 系统管理 > 管理插件 > 可选插件中搜索并安装CheckStyle插件:

下载CHECKSTYLE一体化JAR包

可从以下地址下载CheckStyle一体化Jar包,放在Jenkins所在的服务器上,如/var/jenkins_home目录。注意赋予运行Jenkins的系统用户有适当的权限。

https://github.com/checkstyle/checkstyle/releases/download/checkstyle-8.11/checkstyle-8.11-all.jar

配置JENKINS项目调用CHECKSTYLE并生成报告

可以将CheckStyle的配置文件放在要检查项目的docs目录下,如docs/my_checks.xml。也可以放在Jenkins所在服务器上,通过绝对路径引用文件。在一个已经可以正常构建的Jenkins项目中,增加一个构建步骤“Execute Shell”,其中填写要执行的Java命令:

  1. java -cp /var/jenkins_home/checkstyle-8.11-all.jar com.puppycrawl.tools.checkstyle.Main \
  2. -c docs/my_checks.xml -f xml -o target/checkstyle-result.xml src/

在“构建后操作步骤中”新增一个“Publish Checkstyle analysis results”,在其中配置**/checkstyle-result.xml以表示收集前述步骤产生的结果文件。

重新构建Jenkinks项目,就可以看到CheckStyle的输出结果了:

参考资料

1. http://checkstyle.sourceforge.net/cmdline.html

点赞

发表回复

电子邮件地址不会被公开。必填项已用 * 标注