SonarQube's integration with GitLab self-managed and GitLab.com allows you to maintain code quality and security in your GitLab projects.
With this integration, you'll be able to:
- Authenticate with GitLab: Sign in to SonarQube with your GitLab credentials.
- Import your GitLab projects: Import your GitLab Projects into SonarQube to easily set up SonarQube projects.
- Analyze projects with GitLab CI/CD: Integrate analysis into your build pipeline. Starting in Developer Edition, SonarScanners running in GitLab CI/CD jobs can automatically detect branches or merge requests being built so you don't need to specifically pass them as parameters to the scanner.
- Report your quality gate status to your merge requests: (starting in Developer Edition) See your quality gate and code metric results right in GitLab so you know if it's safe to merge your changes.
- To integrate SonarQube with GitLab self-managed subscriptions, we recommend using GitLab version 15.6+.
- You've set a SonarQube Server base URL in Administration > Configuration > General Settings > General.
Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. Starting in Developer Edition, you can analyze multiple branches and merge requests.
See Authenticating with GitLab for more details on your authentication settings in GitLab.
Setting up the import of GitLab projects into SonarQube allows you to easily create SonarQube projects from your GitLab projects. If you're using Developer Edition or above, this is also the first step in adding merge request decoration.
To set up the import of GitLab projects:
- Set your global settings
- Add a personal access token for importing repositories
To import your GitLab projects into SonarQube, you need to first set your global SonarQube settings. Navigate to Administration > Configuration > General Settings > DevOps Platform Integrations, select the GitLab tab, and specify the following settings:
- Configuration Name (Enterprise and Data Center Edition only): The name used to identify your GitLab configuration at the project level. Use something succinct and easily recognizable.
- GitLab URL: The GitLab API URL.
- Personal Access Token: A GitLab user account is used to decorate Merge Requests. We recommend using a dedicated GitLab account with at least Reporter permissions (the account needs permission to leave comments). Use a personal access token from this account with the api scope authorized for the repositories you're analyzing. Administrators can encrypt this token at Administration > Configuration > Encryption. See the Settings Encryption section of the Security page for more information. This personal access token is used to report your quality gate status to your pull requests. You'll be asked for another personal access token for importing projects in the following section.
After setting these global settings, you can add a project from GitLab by clicking the Add project button in the upper-right corner of the Projects homepage and selecting GitLab.
Then, you'll be asked to provide a personal access token with
read_api scope so SonarQube can access and list your GitLab projects. This token will be stored in SonarQube and can be revoked at any time in GitLab.
After saving your personal access token, you'll see a list of your GitLab projects that you can set up to add to SonarQube. Setting up your projects this way also sets your project settings for merge request decoration.
For information on analyzing your projects with GitLab CI/CD, see the following section.
SonarScanners running in GitLab CI/CD jobs can automatically detect branches or merge requests being built so you don't need to specifically pass them as parameters to the scanner.
The in-product tutorial will give you all the necessary information to analyze your project.
To analyze your projects with GitLab CI/CD, you need to:
- Set your environment variables.
- Configure your gilab-ci.yml file.
The following sections detail these steps.
You need to disable git shallow clone to make sure the scanner has access to all of your history when running analysis with GitLab CI/CD. For more information, see Git shallow clone.
You can set environment variables securely for all pipelines in GitLab's settings. See GitLab's documentation on CI/CD variables for more information.
You need to set the following environment variables in GitLab for analysis:
- Sonar Token: Generate a SonarQube token for GitLab and create a custom environment variable in GitLab with
SONAR_TOKENas the Key and the token you generated as the Value.
- Sonar Host URL: Create a custom environment variable with
SONAR_HOST_URLas the Key and your SonarQube server URL as the Value.
If required, when you select the option that describes your build, SonarQube provides you with a snippet to add to your properties file:
For example, for Gradle, the following samples are provided:
This section shows you how to configure your GitLab CI/CD
gitlab-ci.yml file. The
allow_failure parameter in the examples allows a job to fail without impacting the rest of the CI suite.
You'll set up your build according to your SonarQube edition: You'll set up your build according to your SonarQube edition:
- Community Edition: Community Edition doesn't support multiple branches, so you should only analyze your main branch. You can restrict the analysis to your main branch by using rules to add the branch name in your .yml file.
- Developer Edition and above: By default, GitLab will build all branches but not merge requests. To build merge requests, you need to use rules in your
.gitlab-ci.yml. See the example configurations below for more information.
Select the scanner you're using below to expand an example configuration:
SonarScanner for Gradle
SonarScanner for Maven
A project key has to be provided through
sonar-project.properties or through the command line parameter. For more information, see the SonarScanner documentation.
If you secure your SonarQube instance with a self-signed certificate, you may need to build a custom image based on
sonarsource/sonar-scanner-cli. See the section Advanced docker configuration within the SonarScanner documentation.
SonarScanner for .NET
For some examples, you can refer to the sonarsource-cfamily-examples repository.
In order for the quality gate to fail on the GitLab side when it fails on the SonarQube side, the scanner needs to wait for the SonarQube quality gate status. To enable this, set the
sonar.qualitygate.wait=true parameter in the
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.
For more information on configuring your build with GitLab CI/CD, see the GitLab CI/CD pipeline configuration reference.
After you've set up SonarQube to import your GitLab projects as shown in the previous section, SonarQube can report your quality gate status and analysis metrics directly to GitLab.
To do this, add a project from GitLab by clicking the Add project button in the upper-right corner of the Projects homepage and select GitLab from the drop-down menu.
Then, follow the steps in SonarQube to analyze your project. SonarQube automatically sets the project settings required to show your quality gate in your merge requests.
To report your quality gate status in your merge requests, a SonarQube analysis needs to be run on your code. You can find the additional parameters required for merge request analysis on the Pull request analysis page.
If you're creating your projects manually or adding quality gate reporting to an existing project, see the following section.
SonarQube can also report your quality gate status to GitLab merge requests for existing and manually-created projects. After you've updated your global settings as shown in the Importing your GitLab projects into SonarQube section above, set the following project settings at Project Settings > General Settings > DevOps Platform Integration:
- Configuration name: The configuration name that corresponds to your GitLab instance
- Project ID: your GitLab Project ID found in GitLab
This feature is available starting in Developer Edition and requires GitLab Ultimate.
SonarQube can provide feedback about security vulnerabilities inside the GitLab interface itself. The security vulnerabilities found by SonarQube will appear on the Gitlab > Vulnerability report page.
Make sure the user who owns the personal access token has Browse permission (see Security > Authentication > Project permissions).
To activate this feature, add a vulnerability report stage to your
gitlab.-ci.yml file, as follows:
SonarScanner for Gradle
SonarScanner for Maven
SonarScanner for .NET
Initially, all issues marked Open on SonarQube are marked as Needs triage on GitLab.
When you update the status of an issue in SonarQube, it is also updated in GitLab.
Updating the status of an issue in Gitlab does not update it in SonarQube.
Because the available statuses on the two systems are not exactly the same, the following logic is used to manage the transitions:
|Dismiss||Resolved - Won’t fix|
|Resolved||Closed - Fixed|
The following table presents the severity levels in the two systems:
In Gitlab, your issues might appear duplicated after the modification of a file. We recommend using the Activity > Still detected filter in this case.
Reporting your quality gate status on pull requests in a mono repository
Reporting quality gate statuses to merge requests in a mono repository setup is supported starting in Enterprise Edition.
In a mono repository setup, multiple SonarQube projects, each corresponding to a separate project within the mono repository, are all bound to the same GitLab repository. You'll need to set up each SonarQube project that's part of a mono repository to report your quality gate status.
You need to set up projects that are part of a mono repository manually as shown in the Reporting your quality gate status in GitLab section above. You also need to set the Enable mono repository support setting to true at Project Settings > General Settings > DevOps Platform Integration.
After setting your project settings, ensure the correct project is being analyzed by adjusting the analysis scope and pass your project names to the scanner. See the following sections for more information.
You need to adjust the analysis scope to make sure SonarQube doesn't analyze code from other projects in your mono repository. To do this set up a Source File Inclusion for your project at Project Settings > Analysis Scope with a pattern that will only include files from the appropriate folder. For example, adding
./MyFolderName/**/* to your inclusions will only include code in the
MyFolderName folder. See Narrowing the focus for more information on setting your analysis scope.
Because of the nature of a mono repository, SonarQube scanners might read all project names of your mono repository as identical. To avoid having multiple projects with the same name, you need to pass the
sonar.projectName parameter to the scanner. For example, if you're using the Maven scanner, you would pass
mvn sonar:sonar -Dsonar.projectName=YourProjectName.
To configure pipeline jobs for each project in your mono repository, you must:
- Define a token for all sub-projects in GitLab CI variables. When configuring a mono repo with hundreds of modules, it often makes sense to use one token in GitLab CI.
- See the documentation about how to generate tokens in SonarQube and how to configure your GitLab CI for more information.
- Define a job for each project in
In each job, you must provide the corresponding sonar project key with the option
-Dsonar.projectKey in the script section part of your job (for example, with the key
If you enable fails the pipeline when the quality gate fails, the scanner run in the pipeline will consume minutes for GitLabRunner, pending the result from SonarQube.
Once the previous section is done, you can block pull requests from being merged if it's failing the quality gate :
- In your GitLab repository, go to Your project > Settings > Merge requests
- In the Merge Checks section, select Pipelines must succeed.
More information about GitLab’s External status checks can be found in the GitLab Documentation.
Configuring multiple DevOps platform instances
SonarQube can report your quality gate status to multiple DevOps platform instances. To do this, you need to create a configuration for each DevOps platform instance and assign that configuration to the appropriate projects.
When adding a quality gate status to your merge requests, individual issues will be linked to their SonarQube counterparts automatically. For this to work, you need to correctly set the instance's Server base URL (Administration > Configuration > General Settings > General > General). Otherwise, the links will default to
© 2008-2023, SonarSource S.A, Switzerland. Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution-NonCommercial 3.0 United States License. SONARQUBE is a trademark of SonarSource SA. All other trademarks and copyrights are the property of their respective owners.