# sonar-pdf-plugin

**Repository Path**: matieli/sonar-pdf-plugin

## Basic Information

- **Project Name**: sonar-pdf-plugin
- **Description**: sonarqube生成pdf报告插件，支持sonarqube5.3+版本，支持中文报告
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 116
- **Created**: 2017-05-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Sonar PDF Report Plugin
=========================

Version compatbility : 5.3+. Use maven to build from repository

## 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 into the SONARQUBE_HOME/extensions/plugins directory
1. 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:

![Plugin Configuration](configuration.jpg?raw=true "Plugin Configuration")

### Download the report

PDF report can be downloaded from the SonarQube GUI:
![PDF Report example](output.jpg?raw=true "PDF Report example")

Issue tracking:
https://trello.com/sonarpdf

CI builds:
https://travis-ci.org/gunterweb/sonar-pdf-plugin
https://jenkins-sonarpdfreport.rhcloud.com/