Skip to content

Latest commit

 

History

History
58 lines (47 loc) · 3.92 KB

README.md

File metadata and controls

58 lines (47 loc) · 3.92 KB
Raw

Jenkins Warnings Next Generation Plugin

Join the chat at https://gitter.im/jenkinsci/warnings-plugin Jenkins Plugin Jenkins Plugin Installs Jenkins GitHub Actions Codacy Codecov

The Jenkins Next Generation Warnings plugin collects compiler warnings or issues reported by static analysis tools and visualizes the results. It has built-in support for more than hundred report formats. Among the problems it can detect:

  • errors from your compiler (C, C#, Java, etc.)
  • warnings from a static analysis tool (CheckStyle, StyleCop, SpotBugs, etc.)
  • duplications from a copy-and-paste detector (CPD, Simian, etc.)
  • vulnerabilities
  • open tasks in comments of your source files

The Jenkins Next Generation Warnings plug-in replaces the whole Jenkins Static Analysis Suite. I.e. it makes the following Jenkins plugins obsolete: Android Lint, CheckStyle, Dry, FindBugs, PMD, Warnings, Static Analysis Utilities, Static Analysis Collector.

The plugin publishes a report of the issues found in your build, so you can navigate to a summary report from the main build page. From there you can also dive into the details:

  • distribution of new, fixed and outstanding issues
  • distribution of the issues by severity, category, type, module, or package
  • list of all issues including helpful comments from the reporting tool
  • annotated source code of the affected files
  • trend charts of the issues

If you are using Git as source code management system then the warnings plugin will optionally mine the repository in the style of Code as a Crime Scene (Adam Tornhill, November 2013) to determine statistics of the affected files (i.e. the files with issues):

  • commits count
  • different authors count
  • creation time
  • last modification time
  • lines of code (from the commit details)
  • code churn (changed lines since created)

Additionally, the plugin shows the last person who modified the code that contains an issue (and the last commit ID). In order to use this functionality you need to install the optional Git Forensics Plugin.

If your tool is not yet supported by the warnings plugin you can either define a new Groovy based parser in the user interface or provide a parser within a new small plug-in. If the parser is useful for other teams as well please share it and provide pull requests for the Warnings Next Generation Plug-in and the Analysis Parsers Library.

For more details please refer to the documentation or to an introductory video.

All source code is licensed under the MIT license.