SonarQube PDF Report

SonarQube plugin for PDF reporting

License

License

Categories

Categories

PDF Data
GroupId

GroupId

org.codehaus.sonar-plugins
ArtifactId

ArtifactId

sonar-pdfreport-plugin
Last Version

Last Version

1.4
Release Date

Release Date

Type

Type

sonar-plugin
Description

Description

SonarQube PDF Report
SonarQube plugin for PDF reporting
Project Organization

Project Organization

klicap - ingenieria del puzle
Source Code Management

Source Code Management

https://github.com/SonarCommunity/sonar-pdf-report

Download sonar-pdfreport-plugin

Dependencies

compile (3)

Group / Artifact Type Version
com.lowagie : itext jar 2.1.4
commons-httpclient : commons-httpclient jar 3.1
org.slf4j : jcl-over-slf4j jar 1.7.7

provided (1)

Group / Artifact Type Version
org.codehaus.sonar : sonar-plugin-api jar 4.5.1

test (4)

Group / Artifact Type Version
org.codehaus.sonar : sonar-testing-harness jar 4.5.1
org.apache.maven : maven-project jar 2.0
org.testng : testng jar 5.7
ch.qos.logback : logback-classic jar 1.1.2

Project Modules

There are no modules declared in this project.

Sonar PDF Report Plugin

Compatibility and download information.

Description / Features

Generate a project quality report in PDF format with the most relevant information from SonarQube web interface. The report aims to be a deliverable as part of project documentation.

The report contains:

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

Installation

  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart SonarQube

Usage

SonarQube PDF works as a post-job task. In this way, a PDF report is generated after each analysis in SonarQube.

Configuration

You can skip report generation or select report type (executive or workbook) globally or at the project level. You can also provide an username/password if your project is secured by SonarQube user management:

TODO: [image]

Download the report

PDF report can be downloaded from the SonarQube GUI:

TODO: [image]

Issue tracking: https://jira.codehaus.org/browse/SONARPLUGINS/component/14372

CI builds: https://sonarplugins.ci.cloudbees.com/job/report-pdf

Versions

Version
1.4