<div class="table-wrap"><table style="line-height: 1.4285715;" class="confluenceTable"><tbody><tr><td class="highlight-grey confluenceTd" data-highlight-colour="grey">By <a target="_top" href="http://www.sonarsource.com">SonarSource</a> &#8211; GNU LGPL 3 &#8211;
<a target="_top" href="http://jira.sonarsource.com/browse/SONARJNKNS">Issue Tracker</a> &#8211;
<a target="_top" href="https://github.com/SonarSource/jenkins-sonar-plugin">Sources</a>
<br>
<div>
    <div style="padding-top:10px;padding-bottom:5px">
    <span style="font-size:larger;"><strong>SonarQube Scanner for Jenkins 2.3</strong></span>
<!--     &#8211; Compatible with SonarQube 4.5.4+ (LTS)-->
    <br>
    </div> 
</div> 
</div> </td></tr></tbody></table></div>

Features

You can trigger SonarQube analysis from Jenkins using either a:

Compatibility

SonarQube Scanner for Jenkins

2.12.2.12.3

Jenkins

1.491+1.580.1+1.587+

Prerequisites

Installation

Install the SonarQube Scanner for Jenkins via the Jenkins Update Center.

Server-level Configuration

Adding SonarQube Server

You can define as many SonarQube servers as you wish. Then for each Jenkins job, you will be able to choose which server to use for the SonarQube analysis.

To add a SonarQube server, just follow the three steps below:

 

  1. Log into Jenkins as an administrator and go to Manage Jenkins > Configure System
  2. Scroll down to the SonarQube configuration section, click on "Add SonarQube", and add the values you're prompted for.
  3. For SonarQube servers at version 5.1 or lower, click on the "Advanced..." button and provide database credentials.

 

Adding SonarQube Scanner

This step is mandatory if you want to trigger any of your SonarQube analyses with the SonarQube Scanner

You can define as many SonarQube Scanner launchers as you wish. Then for each Jenkins job, you will be able to choose with which launcher to use to run the SonarQube analysis.

To add a SonarQube Scanner:

  1. Log into Jenkins as an administrator and go to Manage Jenkins > Configure System:
  2. Scroll down to the SonarQube Runner configuration section and click on Add SonarQube Runner. It is based on the typical Jenkins tool auto-installation. You can either choose to point to an already installed version of SonarQube Runner (uncheck 'Install automatically') or tell Jenkins to grab the installer from a remote location (check 'Install automatically'):

If you don't see a drop down list with all available SonarQube Runner versions but instead see an empty text field then this is because Jenkins still hasn't downloaded the required update center file (default period is 1 day). You may force this refresh by clicking 'Check Now' button in Manage Plugins >> Advanced tab.

 

Adding SonarQube Scanner for MSBuild

Refer to Jenkins section of in the SonarQube Scanner for MSBuild documentation.

Job-level Configuration

Configuring a SonarQube Scanner using environment variables

 

If the ability to inject SonarQube configurations as variables in jobs is enabled in the Jenkins' global configuration, you will have ability to activate it in your job. If multiple SonarQube instances are configured, you will be able to choose which one to use.

Press the help button to learn which variables you can use in your build.

You may then use any of the SonarQube Scanners to perform the analysis, such as Maven, Gradle, Ant, etc. An example using maven:

Analyzing

Analyzing with SonarQube Scanner for MSBuild

When analyzing with SonarQube Scanner for MSBuild, there are typically 3 steps:

The begin and end steps are specific job types provided by Sonar Jenkins Plugin:

To perform the rebuild with MSBuild ('msbuild /t:Rebuild'), either configure it with the Jenkins MSBuild plugin, or execute it as a Windows batch command.

Therefore, a typical configuration of a job will have 3 steps:

 

Analyzing with the SonarQube Scanner

Refer to Jenkins section of in the SonarQube Scanner for MSBuild documentation.

Analyzing with SonarQube Scanner for Maven

The Post-build Action for Maven analysis is deprecated.

Use the Build Environment option "Prepare SonarQube Scanner environment" (this option is only available if it has been enabled at the Global level by a Jenkins administrator) to inject SonarQube-related values as environment variables, such as:

Use the help icon ((question)) to see the full list of available variables. Some values will be blank, depending on what was defined for the server.

Once the environment variables are available, use them in a standard Maven build step: