Description / Features
This plugin allows you to generate a project quality report in PDF format that contains with the most relevant information showed by from SonarQube web interface. The report aims to be a deliverable as part of project documentation.
Actually the The report contains:
- Global A dashboard (similar to SonarQube web interface dashboard)
- Violations by categories
- Most violated rules
- Most violated files
- Most complex classes
- Most duplicated files
- Dashboard, violations and hotspots for all child modules (if they exists)
You can download an example of report report here.
This plugin can be used as a Maven plugin (installation in SonarQube not required) or as a SonarQube plugin.
First analyze your project in SonarQube. Then run the generate goal (the report will be created in the target directory):
If your SonarQube server URL is http://localhost:9000 you don't need to specify sonar.host.url.
SonarQube Plugin (post-job)
SonarQube PDF can be used as a plugin of SonarQube modeling a post-job work. In this way, a PDF report is generated after each analysis in SonarQube (
mvn sonar:sonar includes the generation of the report).
How to install SonarQube PDF
Use update center, or alternatively:
- Dowload sonar-pdfreport-plugin-1.3.jar
- Copy to [sonar-dir]/extensions/plugins
- Restart SonarQube
You can skip report generation or select report type (executive or workbook) globally or at top level or the project level. Also you You can also provide an username/password if your project are is secured by SonarQube user management:
PDF report can be downloaded from the SonarQube GUI: