https://github.com/jenkinsci/warnings-ng-plugin

Jenkins Warnings Plugin - Next Generation
https://github.com/jenkinsci/warnings-ng-plugin

checkstyle error-prone findbugs hacktoberfest jenkins jenkins-plugin jenkins-warnings pmd spotbugs static-analysis static-code-analysis

Last synced: 4 days ago
JSON representation

Jenkins Warnings Plugin - Next Generation

• Host: GitHub
• URL: https://github.com/jenkinsci/warnings-ng-plugin
• Owner: jenkinsci
• License: mit
• Created: 2018-10-12T22:41:36.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-01-24T09:20:55.000Z (11 days ago)
• Last Synced: 2025-01-24T15:01:57.021Z (11 days ago)
• Topics: checkstyle, error-prone, findbugs, hacktoberfest, jenkins, jenkins-plugin, jenkins-warnings, pmd, spotbugs, static-analysis, static-code-analysis
• Language: Java
• Homepage: https://plugins.jenkins.io/warnings-ng/
• Size: 26.4 MB
• Stars: 343
• Watchers: 17
• Forks: 279
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Support: SUPPORTED-FORMATS.md

Awesome Lists containing this project

• awesome-software-engineering - :scroll: \[eng\

README

        
# Jenkins Warnings Next Generation Plugin

[![Join the chat at https://gitter.im/jenkinsci/warnings-plugin](https://badges.gitter.im/jenkinsci/warnings-plugin.svg)](https://gitter.im/jenkinsci/warnings-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/warnings-ng.svg?color=red)](https://plugins.jenkins.io/warnings-ng)

[![Jenkins](https://ci.jenkins.io/job/Plugins/job/warnings-ng-plugin/job/main/badge/icon?subject=Jenkins%20CI)](https://ci.jenkins.io/job/Plugins/job/warnings-ng-plugin/job/main/)

[![GitHub Actions](https://github.com/jenkinsci/warnings-ng-plugin/workflows/GitHub%20CI/badge.svg)](https://github.com/jenkinsci/warnings-ng-plugin/actions)

[![Codecov](https://codecov.io/gh/jenkinsci/warnings-ng-plugin/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jenkinsci/warnings-ng-plugin)

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 a hundred [report formats](SUPPORTED-FORMATS.md). 

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 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 over time

![Jenkins Warnings Plug-in](doc/images/jenkins.png)

This code of this plugin is also available as a standalone GitHub or GitLab action that runs without Jenkins now:

- [Quality Monitor GitHub Action](https://github.com/uhafner/quality-monitor): action that monitors the quality of projects based on a configurable set of metrics and gives feedback on pull requests (or single commits) in GitHub.

- [GitHub Autograding action](https://github.com/uhafner/autograding-github-action): action that automatically grades student software projects based on a configurable set of metrics and gives feedback on pull requests (or single commits) in GitHub.

- [GitLab Autograding action](https://github.com/uhafner/autograding-gitlab-action): action that automatically grades student software projects based on a configurable set of metrics and gives feedback on merge requests (or single commits) in GitLab.

![Quality Monitor GitHub Action](doc/images/quality-monitor.png)

If you are using Git as a source code management system then the warnings plugin will optionally mine 

the repository in the style of 

[Code as a Crime Scene](https://www.adamtornhill.com/articles/crimescene/codeascrimescene.htm) 

(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](https://github.com/jenkinsci/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](https://github.com/jenkinsci/warnings-ng-plugin/pulls) and 

the [Analysis Parsers Library](https://github.com/jenkinsci/analysis-model/pulls). 

For more details please refer to the [documentation](doc/Documentation.md) or to an 

[introductory video](https://www.youtube.com/watch?v=0GcEqML8nys). Contributions are welcome, please 

refer to the separate [CONTRIBUTING](CONTRIBUTING.md) document

for details on how to proceed!

All source code is licensed under the MIT license.