# Adding analysis to a Jenkins job

This section explains how to add the SonarQube Community Build analysis to your Jenkins Freestyle or Pipeline jobs. Note that you can also easily configure and analyze your projects with Jenkins in SonarQube Community Build through the tutorial in the application.

To be able to add a SonarQube Community Build analysis to a Jenkins job, you must first integrate Jenkins with SonarQube.

{% hint style="info" %}
SonarQube Community Build doesn’t allow you to add analysis to a Multibranch Pipeline job. See [feature-comparison-table](https://docs.sonarsource.com/sonarqube-community-build/feature-comparison-table "mention") to find out which SonarQube deployments support multi-branch analysis.
{% endhint %}

## Adding analysis to a Freestyle job <a href="#freestyle-job" id="freestyle-job"></a>

The procedure depends on the project type.

{% tabs %}
{% tab title="MAVEN OR GRADLE" %}

1. Create and configure your Jenkins job, and go to the **Build Environment** section.
2. Enable **Prepare SonarScanner environment** to allow the injection of SonarQube Community Build values into this particular job. If multiple SonarQube Community Build instances are configured, you will be able to choose which one to use. Once the environment variables are available, use them in a standard Maven build step (**Invoke top-level Maven targets**) by setting the **Goals** to include, or a standard Gradle build step (**Invoke Gradle script**) by setting the **Tasks** to execute.

Maven goal:

```css-79elbk
$SONAR_MAVEN_GOAL
```

Gradle task:

```css-79elbk
sonar
```

{% hint style="info" %}
In both cases, launching your analysis may require authentication. In that case, make sure that the global configuration in Jenkins of your SonarQube Community Build installation defines a valid SonarQube Community Build token (see [global-setup](https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/ci-integration/jenkins-integration/global-setup "mention")).
{% endhint %}
{% endtab %}

{% tab title=".NET" %}

1. Create and configure your Jenkins job, and go to the **Build** section.
2. Add the **SonarQube for MSBuild - Begin Analysis** to your build.
3. Configure the SonarQube Project Key, Name, and Version in the **SonarScanner for MSBuild - Begin Analysis** build step.
4. Add the compatible **MSBuild build step** or the **Execute Windows batch command** to execute the build.
5. Add the **SonarQube for MSBuild - End Analysis** build steps to your build.

{% hint style="info" %}
In version 5.0 of the SonarScanner, we changed the name of the *SonarScanner for MSBuild* to *SonarScanner for .NET*.

The documentation is updated with the new name and we will call the scanner *SonarScanner for .NET* moving forward.
{% endhint %}
{% endtab %}

{% tab title="OTHER" %}

1. Create and configure your Jenkins job, and go to the **Build** section.
2. Add the SonarScanner CLI build step to your build.
3. Configure the analysis properties. You can either point to an existing `sonar-project.properties` file or set the analysis properties directly in the **Analysis properties** field.
   {% endtab %}
   {% endtabs %}

## Adding analysis to a Pipeline job <a href="#pipeline-job" id="pipeline-job"></a>

1. In Jenkins, create your Pipeline job.
2. Add the SonarQube Community Build analysis stage to the Jenkins file: see below.
3. [pipeline-pause](https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/ci-integration/jenkins-integration/pipeline-pause "mention") until the quality gate is computed.

## Adding an analysis stage to the Jenkins file <a href="#add-analysis-stage" id="add-analysis-stage"></a>

You must use the `withSonarQubeEnv` step in the SonarQube Community Build analysis stage of your pipeline job. This step is used to set the environment variables necessary to connect to the specified SonarQube Community Build instance. The connection details are retrieved from the Jenkins global configuration.

The `withSonarQubeEnv`() method can take the following optional parameters:

* `installationName`(string): name of the SonarQube Community Build installation as configured in Jenkins.\
  This is necessary if several SonarQube SonarQube Community Build hosts are configured in Jenkins.
* `credentialsId`(string): if you want to overwrite the credentials configured in the Jenkins global configuration.
* `envOnly`(boolean): set it to true if you only want the SonarQube Community Build environment variables to be expanded in the build context

### Examples <a href="#examples" id="examples"></a>

Note that you don’t need to specify an SCM stage in your Jenkins Pipeline or Multibranch Pipeline job.

{% tabs %}
{% tab title="GRADLE" %}
Scripted pipeline example:

```css-79elbk
node {
  stage('SonarQube analysis') {
    withSonarQubeEnv() { // Will pick the global server connection you have configured
      sh './gradlew sonar'
    }
  }
}
```

{% endtab %}

{% tab title="MAVEN" %}
Scripted pipeline example:

```css-79elbk
node {
  stage('SonarQube analysis') {
    withSonarQubeEnv(credentialsId: 'f225455e-ea59-40fa-8af7-08176e86507a', installationName: '<sonarqubeInstallation>') { // You can override the credential to be used, If you have configured more than one global server connection, you can specify the corresponding SonarQube installation name configured in Jenkins
      sh 'mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922:sonar'
    }
  }
}
```

{% endtab %}

{% tab title=".NET" %}
Scripted pipeline example:

```css-79elbk
node {
  stage('Build + SonarQube analysis') {
    def sqScannerMsBuildHome = tool 'Scanner for .Net Framework'
    withSonarQubeEnv(<sonarqubeInstallation>') {// If you have configured more than one global server connection, you can specify its name as configured in Jenkins
      bat "${sqScannerMsBuildHome}\\SonarScanner.MSBuild.exe begin /k:myKey"
      bat 'MSBuild.exe /t:Rebuild'
      bat "${sqScannerMsBuildHome}\\SonarScanner.MSBuild.exe end"
    }
  }
}
```

{% endtab %}

{% tab title="OTHER" %}
Scripted pipeline example:

```css-79elbk
node {
  stage('SonarQube analysis') {
    def scannerHome = tool '<sonarqubeScannerInstallation>'; // must match the name of an actual scanner installation directory on your Jenkins build agent
    withSonarQubeEnv('<sonarqubeInstallation>') { // If you have configured more than one global server connection, you can specify its name as configured in Jenkins
      sh "${scannerHome}/bin/sonar-scanner"
    }
  }
}
```

Declarative pipeline example:

```css-79elbk
pipeline {
  agent any
  stages {
    stage('SonarQube analysis') {
      steps {
        script {
            scannerHome = tool '<sonarqubeScannerInstallation>'// must match the name of an actual scanner installation directory on your Jenkins build agent
        }
        withSonarQubeEnv('<sonarqubeInstallation>') {// If you have configured more than one global server connection, you can specify its name as configured in Jenkins
          sh "${scannerHome}/bin/sonar-scanner"
        }
      }
    }
  }
} 
```

{% endtab %}
{% endtabs %}

## Related pages <a href="#related-pages" id="related-pages"></a>

* [key-features](https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/ci-integration/jenkins-integration/key-features "mention")
* [global-setup](https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/ci-integration/jenkins-integration/global-setup "mention")
* [pipeline-pause](https://docs.sonarsource.com/sonarqube-community-build/analyzing-source-code/ci-integration/jenkins-integration/pipeline-pause "mention")