https://github.com/sonarsource/sonarcloud-circleci-orb
Support of SonarScanner CLI in CircleCI
https://github.com/sonarsource/sonarcloud-circleci-orb
circleci circleci-orbs sonarcloud
Last synced: 3 months ago
JSON representation
Support of SonarScanner CLI in CircleCI
- Host: GitHub
- URL: https://github.com/sonarsource/sonarcloud-circleci-orb
- Owner: SonarSource
- License: gpl-3.0
- Created: 2019-09-24T07:46:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-19T15:04:42.000Z (5 months ago)
- Last Synced: 2025-06-08T11:51:23.499Z (4 months ago)
- Topics: circleci, circleci-orbs, sonarcloud
- Language: Shell
- Homepage:
- Size: 37.1 KB
- Stars: 14
- Watchers: 22
- Forks: 24
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# sonarcloud-circleci-orb
Support for SonarScanner CLI in CircleCI
## SonarQube Cloud Orb
The SonarQube Cloud Orb can be used with any Linux-based Docker image that includes the command-line tools `curl` and `unzip`.
### Connecting to the EU region
- To connect to your SonarQube Cloud project on `sonarcloud.io`, you need to set up an API token. We recommend setting up a CircleCI context in your organization named `sonarcloud` that contains a variable with the key `SONAR_TOKEN` and the API token as the value.
### Connecting to the US region
- To connect to your SonarQube Cloud project in the US region, `sonarqube.us`, you need to pass the `sonar.region=US` parameter to the scanner. For this, we recommend adding the `SONAR_REGION` environment variable to your CircleCI context with the value `US`.
- To set up the API token, the recommendation is the same as for the EU region.
### Usage examples
See files in [the `examples` directory](https://github.com/SonarSource/sonarcloud-circleci-orb/tree/master/src/examples) for examples of how to use the orb.
### Publishing a new version
To publish a new version of the orb, you need to change the version found in `.circleci/config.yml` to the new version. The CircleCI build pipeline will then publish the new version of the orb.
### Requirements
See https://docs.sonarcloud.io/appendices/scanner-environment/