配置环境
首先,checkstyle是个java插件,我们可以下载对应jar包,去执行该jar检查指定路径下的java代码风格。所以环境必须有checkstyle的jar包和jdk。
新建项目
源码管理
我们可以选择新建一个自由风格的项目,当然也可以用流水线。但是我们只有checkstyle这一步,所以没必要用流水线。新建后,指定项目的git仓库,添加拉取git的账号密码,如图所示。执行构建时,Jenkins会自动拉取源码到当前工作空间。
构建
之后选择构建的具体操作,我这里选择“执行shell”,也就是checkstyle一下源码并输出xml结果文件,该文件后续会被捕获输出。
# -cp 指定依赖的jar
# -c 代码风格规范
# -f 输出内容的格式
# -o 输出的文件
# ${WORKSPACE} Jenkins的环境变量,也就是源码拉去下来所在的路径
java -cp /var/lib/jenkins/code_check/checkstyle/checkstyle-8.45-all.jar com.puppycrawl.tools.checkstyle.Main -c /var/lib/jenkins/code_check/checkstyle/google_checkstyle.xml -f xml -o checkstyle_result.xml ${WORKSPACE}
构建后操作
构建完,也就是执行上述的shell后,会在当前工作空间下生成checkstyle_result.xml文件,也就是检查的结果。我们需要扫描它并生成可视化结果
测试
我们可以测试一下,最终会得到检查的结果
评论区