Using various features when adding SonarQube analysis to your Azure build pipeline

The file configuration mode is the default mode of the Azure DevOps Extension for SonarQube. 

YAML pipeline

1. Make sure the configMode input of the SonarQubePrepare task is set to file.
2. To use a different configuration file than sonar-project.properties, add the configFile task input to the SonarQubePrepare task, with the path to the configuration file as the value. The path can be absolute, or relative to the repository root.

Classic pipeline

In the Prepare Analysis Configuration task:

1. Make sure the Store configuration with my source code mode is selected.
2. In Settings file, you can define a different configuration file than sonar-project.properties. The path can be absolute, or relative to the repository root.

To define analysis parameters at the pipeline level in Standalone SonarScanner CLI mode, proceed as described below.

YAML pipeline

1. Make sure the configMode task input in the SonarQubePrepare task is set to  manual.
2. Use the extraProperties task input in the SonarQubePrepare task to define the analysis parameters: define a new sonar property by adding <propertyKey>=<propertyValue> on a new line. 

Classic pipeline

In the Prepare Analysis Configuration task:

1. Select the Manually provide configuration mode and enter the required parameters.

2. In Advanced section > Additional properties, define a new sonar property by adding <propertyKey>=<propertyValue> on a new line. 
Example: sonar.exclusions=**/*.bin

You must specify the full version number, such as 8.0.3.99785 (and not 8.0.3). All of the available version numbers can be found here.

YAML pipeline

Add the following input to the Prepare Analysis Configuration task:

• dotnetScannerVersion: The SonarScanner for .NET version to be downloaded.
  

The code snippet below shows a task configuration example. For more information about the task inputs, see SonarQube tasks.

- task: SonarQubePrepare@7

  inputs:

    SonarQube: '<YourSonarqubeServerEndpoint>'

    scannerMode: 'dotnet'

    dotnetScannerVersion: '8.0.3.99785'

    projectKey: '<YourProjectKey>'

Classic pipeline

In Scanner Version, enter the version to be downloaded.

You must specify the full version number, such as 6.0.0.4432 (and not 6.0.0). All of the available version numbers can be found here.

YAML pipeline

Add the following input to the Prepare Analysis Configuration task

• cliScannerVersion: The SonarScanner CLI version to be downloaded.
  

The code snippet below shows a task configuration example. For more information about the task inputs, see  SonarQube tasks.

- task: SonarQubePrepare@7

  inputs:

    SonarQube: '<YourSonarqubeServerEndpoint>'

    scannerMode: 'cli'

    configMode: 'file'
    configFile: 'my-config.properties'	

    cliScannerVersion: '6.0.0.4432'

    cliProjectKey: '<YourProjectKey>'

    cliSources: '.' 

Classic pipeline

In Scanner CLI Version, enter the version to be downloaded.