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.9
- Fixed computation of module names for maven projects (issue #6768)
- Don't report an error message if a maven module does not contain a report file (issue #6895)
- Fixed ant links (issue #6862)
Release 3.8
Release 3.7
Release 3.6
- Fixed broken links to project page and overview image (issue #6417)
Release 3.5
- Added trend graph portlets for the dashboard view
- Added option to start the plug-in even for failed builds (issue #6117)
- Added 'enlarge' link for trend graphs that shows a detail page with the graph
- Fixed ordering of warnings in detail views (issue #6132)
- Fixed warning distribution graph in files detail view (issue #6139)
Release 3.4
Release 3.3
- New warnings computation is now based on the current build and the reference build (i.e., the last successful build, see issue #5147)
- Visualized plug-in build status (based on the healthiness thresholds)
- Added high scores for successful builds
- Don't show project action if there are no warnings (issue #5473)
- Don't show trend graph configuration on job creation (issue #5294)
- Improved remote API, now the warning keys are also exposed (issue #5195)
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 (19)
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, 2009
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, 2009
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, 2009
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, 2010
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
Feb 21, 2010
Romain Seguy says:
You're using a version of the plugin which is built against a more recent versio...You're using a version of the plugin which is built against a more recent version of Hudson ==> Either downgrade the plugin or upgrade your Hudson version.
May 11
Skifflad says:
Just upgraded to Hudson 1.357 with Checkstyle Plug-In 3.6 and Static Analysis Co...Just upgraded to Hudson 1.357 with Checkstyle Plug-In 3.6 and Static Analysis Collector 1.5.
Checkstyle is running ok, but the plug-in is reporting a red ball error on each specific build page where there are checkstyle warnings to report. When you click on Warnings, you see the Warnings page with a correct Summary, but the details section is only showing the Tab headings (Packages, Files, Warnings, Details) but nothing further ?
Anybody else seeing same ?
May 11
Trent McClenahan says:
Yep, I've got the same here.... haven't been able to work it out yet... fingers ...Yep, I've got the same here.... haven't been able to work it out yet... fingers crossed the guys are on to it!
May 13
Skifflad says:
I've just added an issue.I've just added an issue.
Jun 03
Sven Oppermann says:
I want to fail the build if there is a new warning in checkstyle. But if i set t...I want to fail the build if there is a new warning in checkstyle. But if i set the boundary for "new" under the "red ball" to one, it doesnt work. Do i miss something !?!?!
Jun 04
Ulli Hafner says:
You need to use '0' if the build should fail on 1 warning! What does the checks...You need to use '0' if the build should fail on 1 warning!
What does the checkstyle plug-in report in the console?
E.g.:
Jun 04
Sven Oppermann says:
My log looks like: [CHECKSTYLE] Successfully parsed file /home/workarea/zvs/wo...My log looks like:
It is a maven job in hudson and the project itself is a multi modul maven project. I set the boundary to 0 but it is still not working...
Jun 24
Sven Oppermann says:
i digged deeper and i couldnt find a solution. What i did: 1. created a "Hello ...i digged deeper and i couldnt find a solution. What i did:
1. created a "Hello World " maven app: "mvn archetype:create -DgroupId=... -DartifactId=helloWorld" and added the checkstyle plugin to the reporting section
2. installed a clean hudson
3. added "Checkstyle Plug-in 3.8" and "Static Analysis Collector Plug-in 1.6" to hudson
4. created a new maven job in hudson for this "hello world" project
mvn goal: "mvn clean install site"
checkstyle settings: "red ball (total): 1" "red ball(new): 0"
The output:
------------------------------------------------------- T E S T S ------------------------------------------------------- Running de.mms_dresden.zvs.testproject.AppTest Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.063 sec Results : Tests run: 1, Failures: 0, Errors: 0, Skipped: 0 [HUDSON] Zeichne Testergebnisse auf [INFO] [jar:jar {execution: default-jar}] [INFO] Building jar: D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\helloWorld\target\helloWorld-1.0-SNAPSHOT.jar [INFO] [install:install {execution: default-install}] [INFO] Installing D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\helloWorld\target\helloWorld-1.0-SNAPSHOT.jar to D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\.repository\de\mms_dresden\zvs\testproject\helloWorld\1.0-SNAPSHOT\helloWorld-1.0-SNAPSHOT.jar [INFO] [site:site {execution: default-site}] [INFO] Generating "Project Team" report. [INFO] Generating "Issue Tracking" report. [INFO] Generating "Checkstyle" report. [INFO] [INFO] There are 12 checkstyle errors. [WARNING] Unable to locate Source XRef to link to - DISABLED [INFO] Generating "Continuous Integration" report. [INFO] Generating "Project Plugins" report. [INFO] Generating "Dependencies" report. [INFO] Generating "Plugin Management" report. [INFO] Generating "Mailing Lists" report. [INFO] Generating "Source Repository" report. [INFO] Generating "Project Summary" report. [INFO] Generating "About" report. [INFO] Generating "Project License" report. [CHECKSTYLE] Successfully parsed file D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\helloWorld\target\checkstyle-result.xml of module helloWorld with 12 warnings. [HUDSON] Archiving site from D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\helloWorld\target\site to D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\site\helloWorld [HUDSON] Archiving D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\helloWorld\pom.xml to D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\modules\de.mms_dresden.zvs.testproject$helloWorld\builds\2010-06-24_14-19-43\archive\de.mms_dresden.zvs.testproject\helloWorld\1.0-SNAPSHOT\pom.xml [HUDSON] Archiving D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\workspace\helloWorld\target\helloWorld-1.0-SNAPSHOT.jar to D:\projekte\hudson\checkstyle-3.8\work\jobs\helloWorld\modules\de.mms_dresden.zvs.testproject$helloWorld\builds\2010-06-24_14-19-43\archive\de.mms_dresden.zvs.testproject\helloWorld\1.0-SNAPSHOT\helloWorld-1.0-SNAPSHOT.jar [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ [INFO] Total time: 1 minute 18 seconds [INFO] Finished at: Thu Jun 24 14:21:04 CEST 2010 [INFO] Final Memory: 39M/254M [INFO] ------------------------------------------------------------------------ channel stopped Finished: SUCCESSshould i create a ticket?
Jun 25
Ulli Hafner says:
I see, you are using a m2 build. Currently the thresholds don't work for m2 buil...I see, you are using a m2 build. Currently the thresholds don't work for m2 builds: see http://issues.hudson-ci.org/browse/HUDSON-4912.
Jun 25
Sven Oppermann says:
i found a workaround. if i activate the "Checkstyle Plugin " and the "Static Ana...i found a workaround. if i activate the "Checkstyle Plugin " and the "Static Analysis Collector Plug-in" and set the bounderies on the "Static Analysis Collector Plug-in", it fails the build.