Since SonarQube 3.4, 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 sonar-project.properties project configuration file
- or in the sonar-runner.properties global configuration file
To help you getting get started, for each language, a simple project sample is available samples are available for most languages on github that . They can be browsed or downloaded: . You'll find them filed under projects/languages.
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
- Properties are inherited from parent to children
They can obviously 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 the way how to redefine the base directory of the modules in each:
the folder of a module contains white spaces or special characters:
Code Block language bash
module1.sonar.projectBaseDir=My Module One
the module is not located directly in the parent folder, but in a deeper directory structure:
Code Block language bash
- 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
Before SonarQube 3.6, it was only possible to run a project analysis. Since SonarQube 3.6, it is possible to run other tasks such as:
# To run the computation of views (Views plugin is required) sonar-runner views # To run the computation of reports (Report plugin is required) sonar-runner report # To run the computation of developersdeveloper data (Developer Cockpit plugin is required) sonar-runner devcockpit
Additional analysis parameters can be defined in this project configuration file or through command-line parameters.
If you get an java.lang.OutOfMemoryError, you can set the SONAR_RUNNER_OPTS environment variable, like this in *nix environments:
On Windows environments, avoid the double-quotes, since they get misinterpreted , turning and combine the two parameters into a single one.