Project analysis setup

This page introduces briefly the prerequisites and the setup steps necessary for a project analysis with SonarQube.

This page introduces briefly the prerequisites and the setup steps necessary for a project analysis.

For an overview of the analysis process, see SonarQube analysis overview.

Prerequisites and recommendations

SonarQube is integrated with your DevOps platform / CI tool

It is highly recommended that you integrate SonarQube with your DevOps platform or CI tool. See:

• Introduction

• Setting up integration at global level

• Bitbucket Server integration

• Bitbucket Cloud integration

• Azure DevOps integration

• Setting up Jenkins

The SonarScanner is installed on the CI/CD host

The SonarQube analysis overview must be installed on the CI/CD host. You must install the scanner that is most appropriate for your needs depending on your build system: Gradle, Maven, .NET, NPM, or Python. For other project types, use the SonarScanner CLI which requires more manual configuration.

For installation requirements, see General requirements.

For installation instructions, see the corresponding SonarScanner section: SonarScanner for Maven, SonarScanner for Gradle, Installing the scanner, Installing the scanner, SonarScanner for Python, or SonarScanner CLI.

SCM integration used during the analysis will be automatically imported from Git and SVN. Other providers require additional plugins.

Creating your SonarQube project

Your project repository is represented in SonarQube by a project.

You can create your SonarQube project in the SonarQube UI before starting the first project analysis. Or you can start your first project analysis to automatically create the SonarQube project on the server (SonarQube creates automatically a new project if the received project key does not exist in its database).

To create a project, see Creating and importing projects.

Integrating SonarQube analysis into your CI or build pipeline

To integrate the SonarQube analysis into your CI pipeline, see the corresponding section:

• Jenkins: Adding analysis to a Jenkins job

• GitHub Actions: Adding analysis to GitHub Actions workflow

• GitLab CI/CD: Adding analysis to GitLab CI/CD pipeline

• Azure DevOps integration

• Bitbucket Cloud integration

To integrate the SonarQube analysis into your build pipeline, see the scanner invoking instructions in the corresponding section: SonarScanner for Maven, SonarScanner for Gradle, Using the scanner, Using the scanner, SonarScanner for Python, or SonarScanner CLI.

For general information about SonarQube integration with a CI or build pipeline, see SonarQube analysis overview.

Adjusting the analysis of your project

The analysis performed by the SonarScanner is configured through analysis parameters. The following applies:

• A few analysis parameters are mandatory.

• Many analysis parameters, such as those defining the analysis scope, have a default value and can be adjusted.

• Analysis parameters allow you to include the code and test coverage in your analysis, or to import issues generated by a third-party analyzer, etc.

SonarQube manages the analysis parameters through sonar properties (The sonar property key has the following syntax: sonar.<property>.).

You can configure the analysis parameters in different places. For more information, see Analysis parameters and the respective SonarScanner section: SonarScanner for Maven, SonarScanner for Gradle, Using the scanner, Configuring the scanner, SonarScanner for Python, or SonarScanner CLI.

You can:

• Include the code and test coverage in your analysis: see Overview.

• Adjust the analysis scope: see Analysis scope.

• Import issues generated by third-party analyzers: see the External analyzer reports section.