SonarQubeCommunity/sonar-pdf-report

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.SonarQubeCommunity:sonar-pdf-report:1.4'
	}
	dependencies {
		implementation("com.github.SonarQubeCommunity:sonar-pdf-report:1.4")
	}
	<dependency>
	    <groupId>com.github.SonarQubeCommunity</groupId>
	    <artifactId>sonar-pdf-report</artifactId>
	    <version>1.4</version>
	</dependency>

                            
    libraryDependencies += "com.github.SonarQubeCommunity" % "sonar-pdf-report" % "1.4"
        
        

                            
    :dependencies [[com.github.SonarQubeCommunity/sonar-pdf-report "1.4"]]

Readme

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