https://github.com/simonscholz/report-aggregator

This project should be used to aggregate the reports of different code analysis tools, like SpotBugs, PMD, Checkstyle and more...
https://github.com/simonscholz/report-aggregator

checkstyle spotbugs spring-boot spring-shell

Last synced: about 1 year ago
JSON representation

This project should be used to aggregate the reports of different code analysis tools, like SpotBugs, PMD, Checkstyle and more...

• Host: GitHub
• URL: https://github.com/simonscholz/report-aggregator
• Owner: SimonScholz
• License: apache-2.0
• Created: 2018-06-01T16:51:55.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-01-03T17:49:58.000Z (over 6 years ago)
• Last Synced: 2025-04-14T04:54:16.701Z (about 1 year ago)
• Topics: checkstyle, spotbugs, spring-boot, spring-shell
• Language: XSLT
• Homepage:
• Size: 173 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
== Report Aggregator

Running a build with SpotBugs is nice, but the only thing you get is a bunch of XML files in the build folder.

You can use many different xslt scripts to transform these XML files to HTML, but then you just have plenty of different html reports for each and every project, which has been checked by SpotBugs...

This Gradle plug-in tries to aggregate this information in one single XML file and then generates an aggregated HTML report for all projects

== Using this Gradle plug-in

This Gradle plug-in can be found here: https://plugins.gradle.org/plugin/com.simonscholz.reports

[source, groovy]

----

plugins {

  id "com.simonscholz.reports" version "0.0.1"

}

----

Adding this Gradle plug-in adds two new tasks to your build file:

* aggregateSpotBugsFiles - just generates a SpotBugsMerged.xml of all _spotbugsXml.xml_ files in build directories of the project (target for Maven, build for Gradle)

* generateAggregatedReport - Generates a _SpotBugsMerged.xml_ file, if not already present, and uses it to create a _SpotBugsMerged.html_ HTML report.

image::img/tasks.png[]

== Viewing the results

The results will be available in the SpotBugsMerged.xml and SpotBugsMerged.html files:

image::img/sample-report.png[]