mirror of
https://github.com/SonarSource/sonarqube-quality-gate-action.git
synced 2026-10-02 01:41:31 +00:00
85 lines
3.3 KiB
Markdown
85 lines
3.3 KiB
Markdown
# SonarQube Quality Gate check [](https://github.com/SonarSource/sonarqube-quality-gate-action/actions/workflows/run-qa.yml)
|
||
|
||
Check the Quality Gate of your code with [SonarQube](https://www.sonarqube.org/) to ensure your code meets your own quality standards before you release or deploy new features.
|
||
|
||
<img src="./images/SonarQube-72px.png">
|
||
|
||
SonarQube is the leading product for Continuous Code Quality & Code Security. It supports most popular programming languages, including Java, JavaScript, TypeScript, C#, Python, C, C++, and many more.
|
||
|
||
## Requirements
|
||
|
||
A previous step must have run an analysis on your code.
|
||
|
||
Read more information on how to analyze your code [here](https://docs.sonarqube.org/latest/analysis/github-integration/)
|
||
|
||
## Usage
|
||
|
||
The workflow YAML file will usually look something like this::
|
||
|
||
```yaml
|
||
on:
|
||
# Trigger analysis when pushing in master or pull requests, and when creating
|
||
# a pull request.
|
||
push:
|
||
branches:
|
||
- master
|
||
pull_request:
|
||
types: [opened, synchronize, reopened]
|
||
name: Main Workflow
|
||
jobs:
|
||
sonarqube:
|
||
runs-on: ubuntu-latest
|
||
steps:
|
||
- uses: actions/checkout@v2
|
||
with:
|
||
# Disabling shallow clone is recommended for improving relevancy of reporting
|
||
fetch-depth: 0
|
||
#Triggering SonarQube analysis as results of it is required by Quality Gate check
|
||
- name: SonarQube Scan
|
||
uses: sonarsource/sonarqube-scan-action@master
|
||
env:
|
||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||
SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
|
||
- name: SonarQube Quality Gate check
|
||
uses: sonarsource/sonarqube-quality-gate-action@master
|
||
# Force to fail step after specific time
|
||
timeout-minutes: 5
|
||
env:
|
||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||
|
||
```
|
||
In case you are using Maven or Gradle scanner in your repository, you should alter the location of the report metadata file by using the optional `scanMetadataReportFile` input.
|
||
|
||
Typically, report metadata file will be located in:
|
||
- `target/sonar/report-task.txt` for Maven projects
|
||
- `build/sonar/report-task.txt` for Gradle projects
|
||
|
||
Example usage:
|
||
```yaml
|
||
uses: sonarsource/sonarqube-quality-gate-action@master
|
||
with:
|
||
scanMetadataReportFile: target/sonar/report-task.txt
|
||
```
|
||
|
||
Make sure to set up `timeout-minutes` property in your step, to avoid wasting action minutes per month.
|
||
|
||
### Environment variables
|
||
|
||
- `SONAR_TOKEN` – **Required** this is the token used to authenticate access to SonarQube. You can read more about security tokens [here](https://docs.sonarqube.org/latest/user-guide/user-token/). You can set the `SONAR_TOKEN` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
|
||
|
||
## Quality Gate check run
|
||
|
||
<img src="./images/QualityGate-check-screen.png">
|
||
|
||
## Limitations
|
||
|
||
This action is not intended to be used with .NET or C/C++ scanner analysis results.
|
||
|
||
## Have questions or feedback?
|
||
|
||
To provide feedback (requesting a feature or reporting a bug) please post on the [SonarSource Community Forum](https://community.sonarsource.com/tags/c/help/sq/github-actions).
|
||
|
||
## License
|
||
|
||
Scripts and documentation in this project are released under the LGPLv3 License.
|