Project analysis setup overview

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

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 the SonarQube analysis to a Jenkins job
• GitHub Actions: Adding the SonarQube analysis to your GitHub Actions workflow
• GitLab CI/CD:  Adding the SonarQube analysis to your GitLab CI/CD pipeline
• Azure Pipelines
• Bitbucket Pipelines

To integrate the SonarQube analysis into your build pipeline, see the scanner invoking instructions in the corresponding section:  Maven, Gradle, NET, NPM, Python, or 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: Maven, Gradle, NET, NPM, Python, or CLI. 

You can:

• Include the code and test coverage in your analysis: see Test coverage.
• Adjust the analysis scope: see Analysis scope.
• Import issues generated by third-party analyzers: see the Importing external issues section.