Plugin Information
This plugin generates the trend report for Checkstyle, an open source static code analysis program.
 | Installation Requirements
This plug-in requires the utility plug-in "analysis-core" (called "Static Analysis Utilities" in the update manager). Please ensure that the latest version of this plug-in is also installed. |
Description
This plug-in is supported by the Static Analysis Collector plug-in that collects different analysis results and shows the results in aggregated trend graphs. Additionally, health reporting and build stability is also based on the aggregated results.
The Checkstyle plug-in scans for checkstyle-result.xml files in the build workspace and reports the number of warnings found. This plug-in is part of the suite of static code analysis plug-ins that are documented on a separate WIKI page.
The following features are provided by this plug-in:
- Configuration of the files to scan after a build.
- Build summary showing the new and fixed warnings of a build
- Several trend reports showing the number of warnings per build
- Overview of the found warnings per module, package, category, or type
- Parsing of Maven pom.xml or Ant build.xml configuration files to obtain the module or project name
- Parsing of Java files to obtain the package or name space name
- Detail reports of the found warnings optionally filtered by severity (or new and fixed)
- Short messages is read from the report file
- Detailed description is read from the Checkstyle library
- Colored HTML display of the corresponding source file and warning lines:
- Direct link to the warning line
- Highlighting of single lines as well as line ranges
- Highlighting of multiple line ranges per warning (different color for primary range)
- Tool tip describing the warning message
- Failure threshold to mark a build as unstable
- Configurable project health support
- Remote API to export the build quality and found warnings
- Works with the freestyle and native m2 build option of Hudson (activated on goal checkstyle:checkstyle or site)
- Localization available for: DE, JA (Please help to localize checkstyle for your locale!)
The current release is available in the download section. This plug-in is developed and maintained by Ullrich Hafner. Please use the Hudson mailing lists or issue tracker to ask questions, create feature request or bug reports, since I don't read the comment section on this page regularly.
Changelog
Release 3.2
Release 3.1
- Fixed trend report link if there are no results available yet (issue #5156)
- Fixed preview of trend reports
- Added dependency to Hudson 1.337 due to a class loader bug in previous versions (issue #4993)
Release 3.0
- Extracted common code of the static code analysis plug-ins into a new utility plug-in "analysis-core"
- Several bug fixes and small improvements
Release 1.x-2.x ChangeLog
Comments (9)
Sep 02, 2008
Mathieu Cousy says:
Hello, We have just updated the plugin to 1.13version and it seems there is a p...Hello,
We have just updated the plugin to 1.13version and it seems there is a problem with the icon management.
Actually in the dashboard we have lost the tooltips and images (replaced by '%') on the projects using checkstyle plugins.
Is there anything to configure in this last version ?
Thanks in advance,
Mathieu
Sep 03, 2008
Ulli Hafner says:
This is a bug. Could you please file an issue? Thanks, UlliThis is a bug. Could you please file an issue?
Thanks, Ulli
Sep 03, 2008
Mathieu Cousy says:
Ok, I have open an issue : https://hudson.dev.java.net/issues/show_bug.cgi?id=23...Ok, I have open an issue : https://hudson.dev.java.net/issues/show_bug.cgi?id=2309
Jan 20, 2009
Zaccret says:
Hi, Could you tell us which Checkstyle and Checkstyle Maven Plugin versions can...Hi,
Could you tell us which Checkstyle and Checkstyle Maven Plugin versions can be used with this plugin ?
Thanks in advance.
Zac
Jan 21, 2009
Ulli Hafner says:
Actually there should be no hard dependencies to a specific version. We are usin...Actually there should be no hard dependencies to a specific version. We are using the latest checkstyle and maven plugin.
Sep 16
Mohamed Osman says:
It seems to get the Source Code Visualization feaute you must have Administer pe...It seems to get the Source Code Visualization feaute you must have Administer permission.
Error:
Access Denied
****** is missing the Administer permission
Is there any reason for this? anyway to get this without setting your self up with admin rights?
Thanks
-Mohamed
Sep 24
Kyle Hebert says:
Hey guys, Is there anyway to configure this plugin to look in a directory besid...Hey guys,
Is there anyway to configure this plugin to look in a directory besides "target" to find the checkstyle-result.xml file.
In my pom.xml I have something like this:
<build>
<directory>build/jars</directory>
...
</build>
The checkstyle:checkstyle goal runs fine and the report gets put in this directory but this plugin can't find it. If I change the directory back to "target" everything works fine...
Any ideas or suggestions would be very appreciated.
Thanks,
Kyle
Oct 02
Christian Schneider says:
Hi, I have a further question considering the rights management: In our setup,...Hi,
I have a further question considering the rights management:
In our setup, the links to the highlighted code are available when an admin is logged in only.
It might make sense, that anonymous user can't see that.
However, even our subproject (job) managers ain't permitted to get the links.
Is that desired behavior?
cheers,
Christian
Feb 02
xavier vignon says:
Hi, I've got a problem with this plugin : after successful installation (and in...Hi,
I've got a problem with this plugin : after successful installation (and installation of the static analysis utilities plugin), when i go on job configuration page, it does not display correctly, and in my jonas console i've got a JellyTagException ... caused by java.lang.NoClassDefFoundError: hudson/tasks/BuildStepMonitor.
Anyone can help me ??
Thx a lot
Xavier