Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Info

This page documents how to trigger a Sonar analysis from a Jenkins job for versions 2.0+.

For versions prior to 2.0, browse this documentation page.

Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel1

Triggering a

...

Project Analysis with the

...

SonarQube Runner

Go to the 'Build' section, click on ' Add build step' and choose 'Invoke Standalone Sonar Analysis':

Configure the Sonar analysis:

Image Removed

Parameters:

Properties

Description

Sonar Installation

Mandatory.
Sonar installation to use.
To manage Sonar installations, see Configuring Sonar Jenkins Plugin.

JDKOptional.
The JDK to use for the Sonar analysis (by default, it is inherited from the job).
Sonar Runner

Mandatory.
Sonar Runner to use to launch the analysis.
To manage Sonar Runners, see Configuring Sonar Jenkins Plugin

Path to project propertiesOptional.
Relative path of the project properties file.

Project properties

Mandatory if 'Path to project properties' is not set.
The properties of the Sonar analysis. The properties defined here will override the ones defined in the project properties file.

Code Block
languagehtml/xml
# required metadata
sonar.projectKey=my:project
sonar.projectName=My project
sonar.projectVersion=1.0
 
# path to source directories (required)
sonar.sources=srcDir1,srcDir2
 
# path to test source directories (optional)
sonar.tests=testDir1,testDir2
 
# path to project binaries (optional), for example directory of Java bytecode
sonar.binaries=binDir
 
# optional comma-separated list of paths to libraries. Only path to JAR file and path to directory of classes are supported.
sonar.libraries=path/to/library.jar,path/to/classes/dir
 
# The value of the property must be the key of the language.
sonar.language=cobol
 
# Additional parameters
sonar.my.property=value

See Analyzing with Sonar Runner for detailed information on configuring a Sonar analysis with the Sonar Runner.

JVM_OPTIONS

The JVM parameters used when executing the Sonar Runner.

Triggering a Sonar Analysis with Maven

SonarQube analysis. You can either point to an existing sonar-project.properties file or set the analysis properties directly in the Project properties field:

Image Added

Triggering a Project Analysis with Maven

 

On a Maven job, go to the 'Post-build Actions' section and click on 'Add post-build action':

...

Then configure this post-build action:

  • Choose the 'Sonar Installation':

  • Fill in the 'Advanced...' parameters as needed:
     

Parameters:

Properties

Description

Sonar Installation

Mandatory.
Sonar installation to use.
To manage Sonar installations, see Configuring Sonar Jenkins Plugin.

Branch

Optional.
sonar.branch property.
See Analysis Parameters for more information.

Language

Mandatory.
sonar.language property.

MAVEN_OPTS

Optional.
To specify JVM options needed when launching Maven as an external process. See MAVEN_OPTS documentation. Shell-like environment variable expansions work in this field, by using the ${VARIABLE} syntax.

JDKOptional.
The JDK to use for the Sonar analysis (by default, it is inherited from the job).

Additional properties

Optional.
Additional properties can be set. See Analysis Parameters for detailed documentation on these additional properties.

Don't use global triggers configurationIf checked, overrides the default trigger actions set at Sonar installation level.

Triggering a Task with the SonarQube Runner

Go to the Build section, click on Add build step and choose Invoke Standalone Sonar Analysis:

Image Added

Configure the task (computation of views, computation of developers, or generation of reports). If you have more than one task to perform, you'll need to configure multiple build steps:

Image Added