为Jenkins启用Checkstyle的首选实践是什么?

Question

大家好:我注意到checkstyle有一个ant任务

http://checkstyle.sourceforge.net/anttask.html

我想要checkstyle运行在我的蚂蚁构建，这是詹金斯。

不幸的是，这些说明有些隐晦——引用了启用项目依赖项、模块和其他特定于ant的配置。我有一个庞大的构建文件，我不是一个真正的构建工程师-所以我想保持简单，不添加太多的负载到脚本。

Jenkins有一个漂亮的小按钮，它支持显示checkstyle结果，然而，Jenkins要求你在运行构建时运行checkstyle并自己配置它。

什么是最简单的方法来修改我的build.xml和ivy.xml(我假设我需要添加checkstyle到ivy以远程获取jar)，以便在运行构建时对所有代码库进行基本的checkstyle分析?

Answer 1

如何在Ant的帮助下完成的示例:

<?xml version="1.0" encoding="UTF-8"?>
<project name="Build" default="build" basedir=".">
    <property file="props.properties"/>
    <taskdef resource="checkstyletask.properties" classpath="${checkstyle.jar.path}"/>
    <target name="build" depends="checkstyle">
        <echo>Starting build</echo>
        <echo>Build finished</echo>
    </target>
    <target name="checkstyle">
        <echo>Starting checkstyle</echo>
        <checkstyle config="rules/sun_checks.xml" failOnViolation="false">
            <fileset dir="src" includes="**/*.java"/>
            <formatter type="plain"/>
            <formatter type="xml" toFile="build/checkstyle_errors.xml"/>
        </checkstyle>
        <echo>Checkstyle finished</echo>
    </target>
</project>

引用自Checkstyle网站:

failOnViolation -指定构建是否继续，即使存在违规行为。默认为"true"。

你可以从这里下载checkstyle-5.4-bin.zip。
发行包包含sun_checks.xml - checkstyle configuration that checks the sun coding conventions和checkstyle-x.x-all.jar库和任务引擎。