Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

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

Description / Features

The Issues Report plugin provides the ability to generate HTML report on issues.

The main use case is for developers to check the code they have added or changed before pushing it back to the SCM.

Here's an example of HTML report (you can download the full report here):

Issues can then be filtered by severity, new issues only, etc.

Sonar Eclipse Plugin

Icon
Note that a SonarQube plugin for Eclipse is also available. It currently supports Java, C/C++ and Python.

Installation

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

Usage

As the main use case is for developers to check the code they have added or changed before pushing it back to the SCM, the Issues Report plugin is usually used in Preview mode. This is this usage that is detailed below.

The only prerequisite is to install and configure your favorite analyzer (SonarQube RunnerMaven or Ant) on your local machine.

Copy the configuration file (sonar-project.properties, pom.xml, etc.) that is used to analyze the project on the remote server to your local machine. Make sure that the sonar.sources property refers to the directory containing the source code on your local machine (or update it accordingly). The tree structure of the source code on your local machine must match the tree structure that has been remotely analyzed by SonarQube. 

To get an HTML report, set the sonar.issuesReport.html.enable property to true. To define its location, set the sonar.issuesReport.html.location property to an absolute or relative path to the destination for the HTML report. The default value is .sonar/issues-report.html for the SonarQube Runner and Ant, and target/sonar/issues-report.html for Maven.

To display a short report in the console, set the sonar.issuesReport.console.enable property to true:

Finally, run a Preview analysis that generates an HTML report:

Another useful feature is to limit the scope to the files that have been recently created or modified. To do so, the sonar.inclusions property can be set. In the following example, only the myCobolProgram.cbl Cobol program will be checked:

Known Limitation

The Issues Report plugin is not yet compatible with multi-module projects. See https://jira.codehaus.org/browse/SONARPLUGINS-2805.

Change Log

com.atlassian.confluence.macro.MacroExecutionException: JIRA project does not exist or you do not have permission to view it.

  • No labels