The SonarQube Runner is recommended as the default launcher to analyze a project with SonarQube.
Create a configuration file in the root directory of the project: sonar-project.properties
Run the following command from the project base directory to launch the analysis:
Any user who's granted Execute Analysis permission can run an analysis.
If the Anyone group is not granted Execute Analysis permission or if the SonarQube instance is secured (the
sonar.forceAuthentication property is set to
true), the credentials of a user having been granted Execute Analysis permission have to be provided through the
sonar.password properties. Example:
sonar-runner -Dsonar.login=myLogin -Dsonar.password=myPassword
Note that for a preview/incremental analysis, the user also has to be granted the Browse permission on the project to be analyzed.
SonarQube 3.4 to 3.6.3
If a project cannot be accessed anonymously, the
sonar.password properties are required to run an analysis on this project. These properties have to be set to the credentials of a user having the User role on this project. You can set them either:
- directly on the command line by adding
- or in the build.xml file
A project cannot be anonymously accessed when either:
sonar.forceAuthenticationproperty is set to
- or the
sonar.forceAuthenticationproperty is set to
falseand the Anyone group has not been granted a User role on the project
Prior to SonarQube 3.4
There is no security restriction.
Since SonarQube 4.2, it is possible to run an analysis on a multi-language project. To do so, the
sonar.language property just has to be removed. Conversely, if for some reason you want to perform a single language-only analysis, make sure
sonar.language is specified.
Converting a Mono-language Project to a Multi-language Project
The first step is to choose which one of these two mono-language projects you will convert to a multi-language project. You will lose the history (timeline, false positives, action plans, etc.) on the one that won't get converted to a multi-language project. In this example, we'll choose to convert the Java project to a multi-language project as most of our code (and therefore history) is Java.
The second step is to run another analysis of this Java project the old way (make sure to explicitly set the
sonar.language property to
java). This step is mandatory to keep the history on the project.
The third and last step is to remove the
sonar.language property and set the
There are two ways to define a multi-module structure in SonarQube:
|Using the given file structure...||... with the given 'properties' files|
Set all the configuration in the properties file in the root folder
Set the configuration in multiple properties files
- Children inherit their parent's properties
Inherited properties can be overriden:
- By prefixing them with the module identifier (way #1)
- Simply by defining them in the sonar-project.properties file located in the module (way #2)
- Module base directory can be specified for special cases
By default, the module base directory is guessed from the module identifier (like in the examples above). But it can be redefined using the
For instance, here are two use cases and how to redefine the base directory of the modules in each:
the folder of a module contains white spaces or special characters:
the module is not located directly in the parent folder, but in a deeper directory structure:
- A project that defines modules (or a module that defines sub-modules) cannot define a source code folder to be analyzed.
- Modules with the same structure: projects/multi-module/sonar-runner/java-sonar-runner-modules-same-structure
- Modules with different structures: projects/multi-module/sonar-runner/java-sonar-runner-modules-different-structures
- A configuration file for each module: projects/multi-module/sonar-runner/java-sonar-runner-modules-own-configuration-file
Running Other Tasks
If a sonar-project.properties file cannot be created in the root directory of the project, there are several alternatives:
The properties can be specified directly through the command line. Ex:
project.settingscan be used to specify the path to the project configuration file (this option is incompatible with the
The root folder of the project to analyze can be set through the
sonar.projectBaseDir property since SonarQube Runner 2.4 (was previously
project.home). This folder must contain a sonar-project.properties file if the mandatory properties (like
sonar.projectKey) are not specified on the command line.
Additional analysis parameters can be defined in this project configuration file or through command-line parameters.