Failing a pipeline job when the quality gate fails
You can ensure your code meets your quality standards by failing your pipeline job when your quality gate fails.
With Jenkins, you can suspend pipeline execution until the analysis' quality gate status is known. See the Jenkins integration page.
With GitHub Actions, you can fail the pipeline job when the quality gate fails using the SonarQube Quality Gate Check Action.
With Bitbucket Pipelines, you can fail the pipeline job when the quality gate fails using the SonarQube Quality Gate Check Pipe.
For other CIs, you can use the
sonar.qualitygate.wait=true analysis parameter in your configuration file. Setting
sonar.qualitygate.wait to true forces the analysis step to poll your SonarQube instance until the quality gate status is available. This increases the pipeline duration and causes the analysis step to fail any time the quality gate fails, even if the actual analysis is successful. You should only use this parameter if it's necessary.
You can set the
sonar.qualitygate.timeout property to the number of seconds that the scanner should wait for a report to be processed. The default is 300 seconds.
For GitLab CI/CD configuration, see the GitLab integration page.
For GitHub Actions configuration, see the GitHub integration page.
For Azure Pipelines configuration, see the Azure DevOps integration page.
For Bitbucket Pipelines configuration, see the Bitbucket Cloud integration page.
For Jenkins configuration, see Jenkins.
© 2008-2022, SonarSource S.A, Switzerland. Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution-NonCommercial 3.0 United States License. SONARQUBE is a trademark of SonarSource SA. All other trademarks and copyrights are the property of their respective owners.