# sonar-pdf-plugin

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

## Basic Information

- **Project Name**: sonar-pdf-plugin
- **Description**: 基于[zzulj/sonar-pdf-plugin](https://gitee.com/zzulj/sonar-pdf-plugin) 的版本代码维护，并支持SonarQube 8.x 版本
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-07
- **Last Updated**: 2021-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sonar-pdf-plugin

#### 介绍
基于[zzulj/sonar-pdf-plugin](https://gitee.com/zzulj/sonar-pdf-plugin) 的版本代码维护，并支持SonarQube 8.x 版本

#### 软件架构
软件架构说明


#### 安装教程

##### Installation

1. 下载对应的版本，将插件复制到SONARQUBE_HOME/extensions/plugins 目录
1. 重启SonarQube

###### Usage

SonarQube PDF是一个 post-job任务. 因此，PDF 报告将在SonarQube分析结束后生成.

###### Configuration

配置Skip为“否”时生成PDF报告功能启用。

配置Username和Password。如果出现HTTP error: 401或者HTTP error: 403, msg: Forbidden，请查看该配置。

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

####### Download the report

5.x版本：PDF在仪表盘中下载，如果没有下载界面，需要在“配置控件”中添加该控件

![PDF Report example](output.jpg?raw=true "PDF Report example")

6.x以及7.x版本：因为UI变化无仪表盘页面，在工程中More菜单下查看![1546412064834](output6.png)

#### 使用说明

编译:mvn clean package -Dmaven.test.skip=true

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

适用SonarQube版本 : 5.5--7.5。

- 2.0.X：适用SONARQUBE5.5--5.6.7版本
- 2.1.x：适用SONARQUBE6.0-6.2版本
- 3.0.x：适用SONARQUBE6.3+
- 4.x：适用SONARQUBE8.2+

##### Description / Features

本插件生成PDF格式的sonarqube报告.

报告包括以下内容:

* 概要

* 静态分析

* 动态分析

* 编码问题

* 热点:
  * 违反最多的规则TOP10
  * 违规最多的文件TOP5
  * 复杂度最高的文件TOP5
  * 重复行最多的文件TOP5

* 违规详情

* 子模块信息（只有在存在时生成）

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)