Checkstyle Plugin

Skip to end of metadata
Go to start of metadata

Plugin Information

Plugin ID checkstyle Changes In Latest Release
Since Latest Release
Latest Release
Latest Release Date
Required Core
Dependencies
3.39
Feb 10, 2014
1.424
maven-plugin (version:1.424, optional)
dashboard-view (version:2.2, optional)
analysis-core (version:1.55)
token-macro (version:1.5.1, optional)
Source Code
Issue Tracking
Maintainer(s)
GitHub
Open Issues
Ulli Hafner (id: drulli)
Usage Installations 2013-Apr 9334
2013-May 9291
2013-Jun 9504
2013-Jul 9932
2013-Aug 9771
2013-Sep 10032
2013-Oct 10288
2013-Nov 10178
2013-Dec 10098
2014-Jan 10644
2014-Feb 10881
2014-Mar 11333

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.

It's about 5 years now since my first Jenkins commit. I hope that you all enjoy using my static code analysis plug-ins and that these plug-ins are very helpful for your projects! There is now an easy way to support the development of these open source plug-ins I just released my Android game Inca Trails. So feel free to support my work for Jenkins by buying this game in Google Play. Of course, the game is worth its price anyway

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 (activated on goal checkstyle:checkstyle or site)
  • Several tokens to simplify post processing of the results
  • 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 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

You can support the development of this open source plug-ins by buying my Android game Inca Trails in Google Play!

Release3.39

Release 3.38

  • Added a view column that shows the number of warnings in a job

Release 3.37

  • Make dependency to ant-plugin optional

Release 3.36

  • Use columns of Checkstyle warnings when parsing files (issue #19122)
  • Fix sorting of warnings that are on same line but different column (issue #19047)
  • Show results of threshold evaluation also in console log (issue #18954)
  • Escape XML symbols in warning messages (issue #17309)

Release 3.35

Release 3.34

Release 3.33

  • Show more details in the fixed warnings view (issue #15959)
  • Aggregate the maven parent module results in failed builds when the failure is caused by a threshold being hit (issue #15324, issue #12342)
  • Optimized http requests for static resources in the analysis plugins (issue #16571)
  • Fixed missing build overview in maven jobs (issue #16518)
  • Always use Xerces when parsing XML files (issue #15613)
  • Read pom.xml to obtain path of output files in maven jobs (issue #16250)
  • Show error message as file content if the source files could not be transferred to the master (issue #16222)

Release 3.32

  • Added option to consider only stable builds when calculating new warnings (Thanks to David Pärsson for the patch, issue #15037)
  • Fixed NPE when comparing warnings (issue #15414, issue #15250)

Release 3.31

Release 3.30

Release 3.29

  • Reduce memory footprint of plug-in (thanks to Kohsuke for the patches)
  • Upgrade to YUI 2.9 (support for new bread crumbs and context menus: issue #13532, thanks to OHTAKE Tomohiro for the patch)

Release 3.28

  • Show all values of difference graph

Release 3.27

  • Added hyperlinks to build summary if threshold is exceeded (issue #12424)

Release 3.26

  • Added option to filter projects with zero warnings in the warnings dashboard portlet (issue #12984)
  • Center the affected source line in source view (issue #13491)
  • Fixed incompatibility of detail tabs with new bread crumb view (issue #13532)

Release 3.25

  • Added a new portlet that shows the warning totals as a line graph

Release 3.24

  • Show build result threshold evaluation information in build summary (issue #12424)
  • Fixed plug-in configuration if used in conjunction with flexible-publisher plug-in (issue #12182, issue #8185)
  • Upgrade to Checkstyle 5.5

Release 3.23

  • Fixed initialization problem when configuring the plug-in for maven jobs. (issue #12075)

Release 3.22

  • Fixed NPE while configuring a graph with no builds yet (issue #12045)
  • Group warnings by relative path if the associated language has no package or namespace concept (issue #11846)
  • Allow skipping of calculating "new" issues (issue #11761)
  • Fixed display of 'Use delta for new warnings' option (issue #11758)
  • Ignore 'new warnings' threshold in the first build (issue #11718)

Release 3.21

  • Fixed enlarge link for trend graphs (issue #11324)
  • Fixed visibility of 'enable trend graph' link
  • Fixed reading of results if analysis is invoked during 'mvn site' (issue #10820)

Release 3.20

  • Ignore failed builds when evaluating the build history in trend graphs and new warnings calculation (issue #10682)
  • Added OSGi bundle detection when grouping warnings by module (issue #10681)
  • Use the path as a replacement for the package grouping for all warnings that are not from Java or C# files (issue 2)

Release 3.19

  • Added new tokens for token macro plug-in (issue #10027): now tokens CHECKSTYLE_NEW, CHECKSTYLE_FIXED, CHECKSTYLE_COUNT and CHECKSTYLE_RESULT are available.

Release 3.18

Release 3.17

  • Fixed display of trend graphs for maven jobs (report)

Release 3.16

  • Fixed health reporting and build failure/unstable thresholds for maven project type (issue #4912, issue #3514)
  • Fixed broken detail views when using a reverse proxy (issue #3410, thanks to Benjamin Cabé for the fix)
  • Show the reference build that is used to compute new and fixed warnings (when build thresholds are set)
  • Improved logging statements when build is executed on a slave

Release 3.15

  • Added configuration option to enable automatic project and module name detection by reading all Ant project.xml and Maven pom.xml files (issue #8915, issue #9090)
  • Added preliminary support for the Token Macro Plugin: CHECKSTYLE_COUNT expands to the number of Checkstyle warnings and CHECKSTYLE_RESULT expands to the plug-in build result (stable, unstable, failed)

Release 3.14

  • Fixed missing dependency to Hudson/Jenkins 1.395 (issue #8509)

Release 3.13

  • Jenkins update to links and documentation
  • Show progress text while dashboard portlet graphs are created

Release 3.12

  • Added support for multi-configuration projects (issue #6772)

Release 3.11

  • Fixed sorting of date labels of dashboard trend graphs (issue #8476)
  • Fixed evaluation of builds that will be considered in the dashboard trend graph (issue #8283)

Release 3.10

  • Added build status thresholds for each warning priority (issue #3561)

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

Labels

Edit
plugin-maven plugin-maven Delete
plugin-report plugin-report Delete
supports-dashboard-view supports-dashboard-view Delete
token-producer token-producer Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Add Comment