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 90 Next »

There is also Commercial edition supported by klicap.

Description / Features

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

  • Global dashboard (similar to Sonar 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 sonar. Then run the generate goal (report will be created in the target directory):

Available properties (-Dproperty=value)

  • sonar.host.url: sonar 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 Sonar server URL is http://localhost:9000 you don't need to specify sonar.host.url.

Sonar Plugin (post-job)

 
Sonar PDF can be used as a plugin of sonar modeling a post-job work. In this way, a PDF report is generated after each analysis in Sonar (mvn sonar:sonar includes the generation of report).
 
How to install Sonar PDF in Sonar
The installation process is the standard process to install any plugin in Sonar:

  • Dowload sonar-pdfreport-plugin-1.2.jar
  • Copy to [sonar-dir]/extensions/plugins
  • Restart Sonar

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 Sonar user management:


Download the report

PDF report can be downloaded from Sonar GUI:

Changelog

Loading

Release 1.2 (5 issues)


Loading

Release 1.1 (1 issues)

Type Key Summary Priority 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)

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


Known limitations

First compatible version: Sonar 1.8

  • No labels