Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 111 Next »

If you are happy with PDF Plugin then you could recommend it.

There is also Commercial edition supported by klicap.

Description / Features

This plugin allows to generate a report in PDF format that contains the most relevant information showed by SonarQube web interface. The report aims to be a deliverable as part of project documentation.
Actually the report contains:

  • Global dashboard (similar to SonarQube web interface dashboard)
  • Violations by categories
  • Hotspots:
    • 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 here.

Usage

Maven Plugin

First analyze your project in SonarQube. Then run the generate goal (report will be created in the target directory):

Available properties (-Dproperty=value)

  • sonar.host.url: SonarQube server URL (i.e http://my-host:9000/sonar)
  • sonar.branch (-Dbranch is also supported): report on a project branch
  • report.type: select a report type. Values:
    • -Dreport.type=executive
    • -Dreport.type=workbook (default)
  • sonar.pdf.username: username for access WS API
  • sonar.pdf.password: password for the user

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

Configuration

You can skip report generation or select report type (executive or workbook) at top level or project level. Also you can provide an username/password if your project are secured by SonarQube user management:

Download the report

PDF report can be downloaded from SonarQube GUI:

Changelog

Loading

Release 1.3.1 (4 issues)

 

Loading

Release 1.3 (5 issues)

 

Loading

Release 1.2.1 (2 issues)

 

Loading

Release 1.2 (5 issues)

 

Loading

Release 1.1 (1 issues)

T Key Summary P Status Resolution
Improvement SONARPLUGINS-433 Enable authentication to web services in the plugin Major Closed Fixed

 

Loading

Release 1.0 (5 issues)

 

Loading

Release 0.3 (3 issues)

 

Loading

Release 0.2 (6 issues)

 

Loading

Release 0.1 (1 issues)

T Key Summary P Status Resolution
New Feature SONARPLUGINS-25 Export as a PDF report Major Closed Fixed

 

Known limitations

Ant task and SonarQube Runner are not supported.

  • No labels