SonarCloud | Advanced setup | CI-based analysis | Jenkins | Key features

On this page

Key features of the SonarCloud integration with Jenkins

SonarSource provides an extension for Jenkins to enable smooth integration with Jenkins. With the SonarCloud extension for Jenkins:

  • You can install the SonarScanner CLI, for Maven, for Gradle, or for .NET from Jenkins and centralize the configuration of SonarCloud connection details in Jenkins global configuration.
  • You can trigger the SonarCloud analysis from your Jenkins Freestyle or Pipeline jobs using standard Jenkins build steps or Jenkins Pipeline DSL. Once the Jenkins job is complete, the extension will detect that a SonarCloud analysis was made during the build and display a badge and a widget on the job page with a link to the SonarCloud dashboard as well as quality gate status.
  • You can configure an automatic failing of your pipeline in case your code fails the quality gate you defined in SonarCloud: see below.

Automatic interruption of your pipeline in case the quality gate fails

With the SonarCloud extension for Jenkins, you can configure that your pipeline job fails in case the quality gate computed by SonarCloud for your project fails. To do so, the extension makes webhook available: a webhook call must be configured in SonarCloud to call back into Jenkins to allow the pipeline to continue or fail.  

The figure below illustrates the process:

  1. A Jenkins Pipeline job is started.
  2. The job triggers the analysis by the SonarScanner.
  3. The SonarScanner sends the results to SonarCloud.
  4. SonarCloud completes the analysis, computes the quality gate configured for the project, and checks if the project fails or passes the quality gate.
  5. SonarCloud sends the pass or failure result back to the Jenkins webhook exposed by the SonarCloud extension for Jenkins.
  6. The pipeline job continues (in case of a pass) or fails (otherwise).

© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARLINT, SONARQUBE, SONARCLOUD, and CLEAN AS YOU CODE are trademarks of SonarSource SA.

Creative Commons License