]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-14645 Update docs on failing pipelines
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>
Mon, 5 Apr 2021 18:07:30 +0000 (13:07 -0500)
committersonartech <sonartech@sonarsource.com>
Tue, 6 Apr 2021 20:03:20 +0000 (20:03 +0000)
server/sonar-docs/src/pages/analysis/analysis-parameters.md
server/sonar-docs/src/pages/analysis/branch-pr-analysis-overview.md

index 8366802bc9d10a363e33d4adcfd200aa5fbd1012..b31e2a099519dab38c3c5a4c4095da246eb4619f 100644 (file)
@@ -95,7 +95,7 @@ Key | Description | Default
 Key | Description | Default
 ---|----|---
 `sonar.qualitygate.wait` | Forces the analysis step to poll the SonarQube instance and wait for the Quality Gate status. If there are no other options, you can use this to fail a pipeline build when the Quality Gate is failing. See the [CI Integration](/analysis/branch-pr-analysis-overview/) page for more information. | 
-`sonar.qualitygate.timeout` | Sets the amount of time (in seconds) that the scanner should wait for a report to be processed. | 300
+`sonar.qualitygate.timeout` | Sets the number of seconds that the scanner should wait for a report to be processed. | 300
 
 ### Deprecated
 [[danger]]
index fb4164179cf488294014e535d4b512a192d53872..e86aff17d5ea936b0547ad6a1fe3780edbb6bfd8 100644 (file)
@@ -11,11 +11,11 @@ SonarScanners running in GitLab CI/CD, Azure Pipelines, Cirrus CI, and Jenkins w
 | Automatic configuration is disabled if any branch or pull request properties have been set manually.
 
 ## Failing a pipeline job when the Quality Gate fails
-If you're using Jenkins or Azure Pipelines, there are specific ways to fail the pipeline when your Quality Gate is failing for your CI tool. For more information, see the corresponding section below.
+If you're using Jenkins, you can suspend pipeline execution until the analysis' Quality Gate status is known. See the [Jenkins](/analysis/jenkins/) integration page.
 
-For other CIs, you can use the `sonar.qualitygate.wait=true` analysis parameter in your configuration file. Using the `sonar.qualitygate.wait` parameter forces the analysis step to poll the SonarQube instance and wait for the Quality Gate status. This increases the pipeline duration and causes the analysis step to fail any time the Quality Gate is failing, even if the actual analysis is successful. You should only use this parameter if it's necessary.
+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 an amount of time (in seconds) that the scanner should wait for a report to be processed. The default is 300 seconds.
+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.
 
 ## GitLab CI/CD
 For GitLab CI/CD configuration, see the [GitLab ALM integration](/analysis/gitlab-integration/) page.