Checkstyle Jenkins - 我该如何在Jenkins中配置Checkstyle？

Question

我刚开始使用Jenkins，最近用它构建了一个项目，并安装了“Checkstyle”插件并收到了一份报告。

我想知道如何配置“Checkstyle”，比如说，忽略空格或其他可能出现的标准？

谢谢！

- Matthew

Answer 1

Jenkins只需在构建过程中运行checkstyle报告后进行阅读，与问题无关。要配置checkstyle，您需要修改或创建checkstyle.xml文件（位置可通过基于您选择的构建自动化工具（例如maven或gradle）的方法进行配置）。checkstyle手册有关于如何实现所需检查的更多详细信息。

- Brandon McKenzie

---

我在我的系统中检查了“checkstyle.xml”，但是唯一显示出来的是与我的Eclipse插件相关联的“checkstyle-config.xml”文件。我正在构建的项目不是基于我的本地机器，而是从Git拉取的URL。下一步该怎么办，我不确定... - Matthew

checkstyle.xml文件可能还不存在，这将导致检查样式使用默认设置。下一步是将该xml添加到项目中，以便您的构建工具可以找到它（或者您已经配置它可以找到它的位置）。完成后，Jenkins将能够读取在构建目录中生成的报告文件。这个git公开吗？你可以发布它吗？另外，你使用的是什么构建工具？我在我的回答中链接了两个较流行的手动输入。 - Brandon McKenzie

这是通过我的雇主。我被指派研究如何限制Checkstyle的检查范围。步骤如下：打开Jenkins Job，构建项目，在构建完成后，将Checkstyle报告发送给相关人员。此外，我们正在使用Maven。我只是不确定在哪里放置checkstyle.cml文件，以便当Jenkins运行并构建项目时，它引用该xml文件来确定要检查和不要检查的内容。 - Matthew

首先，我想非常感谢您的帮助，这对我来说意义重大！ 此外，当我打开我的 Jenkins 作业并点击“构建”时，它显然开始构建代码，然后在构建结束/期间，在仪表板上显示一个可视化图形，告诉我出了什么问题，我可以通过展开图形进一步调查。那么这是在构建完成后读取报告文件的结果吗？如果我理解有误，请纠正我。 - Matthew

啊，那肯定有道理。嗯，但我想知道在Jenkins的哪里放置URL？就是Jenkins工作中的哪个特定文本框。我正在查看我的工作，看起来有各种地方。 - Matthew