SonarQube Cloud

https://docs.sonarsource.com/sonarqube-cloud/
Admin
SonarQube Cloud is a cloud-based Software-as-a-Service (SaaS) automated code review and static...
Tokens:1,081,485
Snippets:6,988
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Maven scripted pipeline example

Source: https://docs.sonarsource.com/sonarqube-cloud/analyzing-source-code/ci-based-analysis/jenkins/add-analysis-to-job.md

Scripted pipeline example using withSonarQubeEnv with credentialsId and installationName to override the credential and specify the SonarCloud installation.

```groovy
node {
  stage('SonarCloud analysis') {
    withSonarQubeEnv(credentialsId: 'f225455e-ea59-40fa-8af7-08176e86507a', installationName: 'SonarCloud') { // You can override the credential to be used
      sh 'mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922:sonar'
    }
  }
}
```

--------------------------------

### Complete GitHub Actions workflow with SonarQube scan

Source: https://docs.sonarsource.com/sonarqube-cloud/analyzing-source-code/test-coverage/php-test-coverage.md

A complete .github/workflows/CI.yml example that includes checkout, PHP setup with Xdebug, dependency installation, test execution with coverage, and a SonarQube scan step. The scan step uses the SONAR_TOKEN secret and runs after the coverage report is generated.

```yaml
name: CI

on:
  - pull_request
  - push
  
jobs:
  tests:
      name: Tests

      runs-on: ubuntu-latest
      
      steps:
        - name: Checkout
          uses: actions/checkout@v6
          with:
            fetch-depth: 0
          
        - name: Setup PHP with Xdebug
          uses: shivammathur/setup-php@v2
          with:
            php-version: '8.1'
            coverage: xdebug
            
        - name: Install dependencies with composer
          run: composer update --no-ansi --no-interaction --no-progress
          
        - name: Run tests with phpunit/phpunit
          run: vendor/bin/phpunit --coverage-clover=coverage.xml
          
        - name: SonarQube Scan
          uses: SonarSource/sonarqube-scan-action@v7
          env:
            SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
```

--------------------------------

### Start SonarScanner for NPM from command line

Source: https://docs.sonarsource.com/sonarqube-cloud/analyzing-source-code/scanners/sonarscanner-for-npm/using

Use the sonar-scanner command to start the analysis. Pass analysis parameters using the standard -Dsonar.xxx=yyy syntax. This example uses the US instance of SonarQube Cloud; remove the sonar.region property to use the EU instance. The project key is optional and defaults to the name field in package.json.

```bash
sonar -Dsonar.region=us -Dsonar.token=<YOUR_TOKEN> -Dsonar.organization=<YOUR_ORGANIZATION_KEY> 
```

--------------------------------

### Example .sonarcloud.properties file with optional settings

Source: https://docs.sonarsource.com/sonarqube-cloud/analyzing-source-code/automatic-analysis.md

Shows the supported optional settings for the .sonarcloud.properties file. Wildcard patterns are not allowed. If settings are also configured in the UI, the values from this file take precedence.

```properties
# Path to sources
# sonar.sources=
# sonar.exclusions=
# sonar.inclusions=

# Path to tests
# sonar.tests=
# sonar.test.exclusions=
# sonar.test.inclusions=

# Source encoding
# sonar.sourceEncoding=

# Exclusions for copy-paste detection
# sonar.cpd.exclusions=

# Python version (for python projects only)
# sonar.python.version=

# C++ standard version (for C++ projects only)
# If not specified, it defaults to the latest supported standard
# sonar.cfamily.reportingCppStandardOverride=c++98|c++11|c++14|c++17|c++20
```

--------------------------------

### Example HTTP GET request for Azure DevOps

Source: https://docs.sonarsource.com/sonarqube-cloud/appendices/troubleshooting.md

Example request using the Azure DevOps platform with organization ID 'org123'. Use this to test if the token is being removed by network interference.

```http
GET https://api.sonarcloud.io/dop-translation/dop-organizations?devOpsPlatform=azure&devOpsPlatformOrganizationId=org123
```

--------------------------------

### Install dotnet-coverage as a global dotnet tool

Source: https://docs.sonarsource.com/sonarqube-cloud/analyzing-source-code/test-coverage/dotnet-test-coverage.md

Installs the dotnet-coverage tool globally. Requires .NET Core 3.1 or later.

```bash
dotnet tool install --global dotnet-coverage
```
Tokens:
Raw