Features

The SonarQubeRunner is recommended as the default launcher to analyze a project with SonarQube.

Prerequisites

• Java 6 or higher

Installation

1. Uncompress the downloaded file into a directory named $SONARQUBE_RUNNER_HOME in the next steps.
    

2. Update the global settings (database connection, server URL) by editing the $SONARQUBE_RUNNER_HOME/conf/sonar-runner.properties file:

    

    

3. Create a new SONAR_RUNNER_HOME environment variable set to $SONARQUBE_RUNNER_HOME.
    
4. Add the $SONAR_RUNNER_HOME/bin directory to your path.
    

5. You can check the basic installation by opening a new shell and executing the command sonar-runner -h (on Windows platform the command is sonar-runner.bat -h) . You should get a message like this:

If you need more debug information you can add the sonar.verbose property by adding the command line parameter -Dsonar.verbose=true.

You are now ready to analyze a project with the SonarQube Runner.

Change Log

Version 2.2.1 (1 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2862	Fresh installation of Sonar Runner doesn't work on Mac OS X 10.8.3

Version 2.2 (6 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2820	End of support of Java 5
	SONARPLUGINS-2775	"sonar.libraries" should allow to specify folders
	SONARPLUGINS-2574	Provide an API to launch Sonar Runner in a dedicated java process
	SONARPLUGINS-2798	Replace "-e" by "-f" in sonar-runner bash script
	SONARPLUGINS-2766	Change location of working directory when running projectless task
	SONARPLUGINS-2794	Remove the task list from the command line help

Version 2.1 (17 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2550	Add the two new properties 'sonar.login' and 'sonar.password' (Sonar 3.4) to the sonar-runner.properties general configuration file
	SONARPLUGINS-2622	Remove project specific settings in sonar-runner.properties file
	SONARPLUGINS-2297	The property sonar.sources should not be mandatory
	SONARPLUGINS-2296	BAT script does not always return the exit code
	SONARPLUGINS-2295	If an aggregator module defines "sonar.sources" and has such a folder, a warning should be raised
	SONARPLUGINS-2285	When the properties "sonar.binaries", "sonar.tests" and "sonar.libraries" doesn't match any existing directory/file the analysis should not fail
	SONARPLUGINS-2540	Provide the ability to execute some plugins like Views or Developer Cockpit plugins without analyzing a technical project
	SONARPLUGINS-2730	sonar.sources property should be optional (in particular for parent modules)
	SONARPLUGINS-2560	Sonar-runner fails to execute properly on z/OS
	SONARPLUGINS-1233	Delete the Sonar working/temporary directory before starting analysis
	SONARPLUGINS-2604	By default, do not display the stack trace when the analysis fails
	SONARPLUGINS-2571	Make the Sonar Runner support a new "-version" option
	SONARPLUGINS-2421	Make it possible to define a multi-modules project whose modules share the same project base directory
	SONARPLUGINS-2399	Comma is badly supported in sonar.projectName property
	SONARPLUGINS-2468	Improve the error message when the bootstrapper fails to connect to server
	SONARPLUGINS-2711	Add SQL Server default configuration to conf/sonar-runner.properties
	SONARPLUGINS-2313	SONAR_RUNNER_HOME: autodetection over symbolic links + validation when automaticly resolved

Version 2.0 (6 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2263	Classloader is not fully isolated
	SONARPLUGINS-1856	When launching the Sonar Runner, a meaningful error message must be thrown when one source directory doesn't exist
	SONARPLUGINS-2217	Move Sonar Batch Bootstrapper classes from Sonar to Sonar Runner
	SONARPLUGINS-2203	Make sure all Sonar properties start with "sonar."
	SONARPLUGINS-2202	Add multi-module support
	SONARPLUGINS-2256	By default sonar-runner should not use UTF-8 to read source code files but the default encoding of the JVM

Version 1.4 (4 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-2044	Check if SONAR_RUNNER_HOME is correctly set
	SONARPLUGINS-2038	Log the value of the system property "sun.arch.data.model" at start-up
	SONARPLUGINS-1921	sonar-runner.bat fails when java.exe is found in the path but contains a space
	SONARPLUGINS-1230	Configure the location of working directory