为 Jenkins 启用 Checkstyle 的首选做法是什么?

发布于 2024-12-11 09:15:03 字数 531 浏览 0 评论 0原文

大家好:我注意到 checkstyle http://checkstyle.sourceforge.net/anttask 有一个 ant 任务

。 html

我希望 checkstyle 在我的 Ant 构建中运行,该构建位于 jenkins 上。

不幸的是,这些说明有些神秘 - 涉及启用项目依赖项、模块和其他特定于 ant 的配置。我有一个巨大的构建文件,而且我并不是真正的构建工程师 - 所以我想保持简单,而不向脚本添加太多的 bload。

Jenkins 有一个漂亮的小按钮,支持显示 checkstyle 结果,但是,jenkins 要求您在运行构建时运行 checkstyle 并自行配置。

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

Hi guys : I noticed that there is an ant task for checkstyle

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

I want checkstyle to run in my Ant build, which is on jenkins.

Unfortunately, the instructions are somewhat cryptic - with references to enabling project dependencies , modules, and other ant-specific configurations. I have a massive build file and I'm not really a build engineer - so I want to keep it simple without adding too much bload to the script.

Jenkins has a nice little button which supports displaying the checkstyle results, however, jenkins requires that you run the checkstyle and configure it yourself when you run a build.

What is the simplest way to modify my build.xml and ivy.xml ( i assume i will need to add checkstyle to ivy to get the jar remotely) to enable a basic checkstyle analysis of all the code base when builds are run ?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

半衾梦 2024-12-18 09:15:03

如何在 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 - 用于检查 sun 编码约定的 checkstyle 配置 和带有任务引擎的 checkstyle-xx-all.jar 库。

The sample of how to do it with help of just 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>

The quote from Checkstyle site:

failOnViolation - Specifies whether the build will continue even if
there are violations. Defaults to "true".

You can download checkstyle-5.4-bin.zip from here.
The distribution package contains sun_checks.xml - checkstyle configuration that checks the sun coding conventions and checkstyle-x.x-all.jar library with task engine.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文