Adding analysis to a Jenkins job
This section explains how to add the SonarQube Community Build analysis to your Jenkins Freestyle or Pipeline jobs.
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.
Adding analysis to a Freestyle job
The procedure depends on the project type.
Create and configure your Jenkins job, and go to the Build Environment section.
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:
$SONAR_MAVEN_GOAL
Gradle task:
sonar
Adding analysis to a Pipeline job
In Jenkins, create your Pipeline job.
Add the SonarQube Community Build analysis stage to the Jenkins file: see below.
Setting up a pipeline pause until the quality gate is computed.
Adding an analysis stage to the Jenkins file
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
Note that you don’t need to specify an SCM stage in your Jenkins Pipeline or Multibranch Pipeline job.
Scripted pipeline example:
node {
stage('SonarQube analysis') {
withSonarQubeEnv() { // Will pick the global server connection you have configured
sh './gradlew sonar'
}
}
}
Related pages
Last updated
Was this helpful?