Skip to content

Commit

Permalink
Update README.md to consider the correct polling timeout property
Browse files Browse the repository at this point in the history
  • Loading branch information
rennanfelizardo authored and jacek-poreda-sonarsource committed Dec 2, 2024
1 parent 721debf commit 07d1da2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ jobs:
- name: SonarQube Quality Gate check
id: sonarqube-quality-gate-check
uses: sonarsource/sonarqube-quality-gate-action@master
# Force to fail step after specific time.
timeout-minutes: 5
with:
pollingTimeoutSec: 600
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }} #OPTIONAL
Expand All @@ -59,7 +59,7 @@ jobs:

```

Make sure to set up `timeout-minutes` property in your step, to avoid wasting action minutes per month (see above example).
Make sure to set up `pollingTimeoutSec` property in your step, to avoid wasting action minutes per month (see above example). If not provided, the default value of 300s is applied.

When using this action with [sonarsource/sonarqube-scan](https://github.com/SonarSource/sonarqube-scan-action) action or with [C/C++ code analysis](https://docs.sonarqube.org/latest/analysis/languages/cfamily/) you don't have to provide `scanMetadataReportFile` input, otherwise you should alter the location of it.

Expand Down

0 comments on commit 07d1da2

Please sign in to comment.