.NET project

Adding the SonarQube Cloud analysis to your Azure build pipeline for .NET projects.

The setup is different depending on whether you use YAML or the Azure Classic interface.

• The use of the Classic interface is not always possible (e.g. if your code is stored on GitHub).
• If you use YAML, Sonar can provide you with YAML templates or code examples.

Before you start

Before starting, read Azure Pipelines integration overview.

The prerequisites are:

• The Azure DevOps Extension is installed in your Azure DevOps organization: see Azure DevOps Extension.
• Your project is created in SonarQube Cloud and:

  • Your project binding with you DevOps platform has been configured. See the Configuring Azure DevOps project binding.
  • Your project has been configured for Azure Pipelines. See Configuring project for Azure Pipelines.
• The pull request and branch analysis are enabled in your pipeline.

If you need to use a specific scanner version, see the Using various features page.

​Analysis parameters can be set at different levels. When creating your pipeline, you will have to enter the project key and you may also enter the project version and name. For more information about these task inputs, see Task inputs specific to the .NET mode. You may define additional parameters in this task. In that case, these parameters have precedence over parameters defined at the project or global level.

Using YAML

Add the following SonarQube tasks to your YAML pipeline:

1. Before your build task, add a Prepare Analysis Configuration task.
2. After your build task, add a Run Code Analysis task.
3. After the Run Code Analysis task, add a Publish Quality Gate Result task.

See the YAML file example below. See also our YAML pipeline templates. For information about the SonarQube task inputs, see the List of SonarQube tasks page.

Make sure the SonarQube task version used in your YAML file is the correct one. For example, in SonarCloudPrepare@3, @3 should correspond to the version of the Azure DevOps Extension you’re using.

YAML file example

trigger:
- main # or another name representing your main branch
- feature/*

steps:
 # Checkout the repository 
- checkout: self

 # Disable shallow fetch
  fetchDepth: 0

# Prepare Analysis Configuration task
- task: SonarCloudPrepare@4
  inputs:
    SonarCloud: '<YourSonarQubeServiceEndpoint>'
    organization: '<YourOrganizationName>'
    scannerMode: 'dotnet'
    projectKey: '<YourProjectKey>'

# Dotnet build task
- task: DotNetCoreCLI@2
  displayName: 'dotnet build'

# Run Code Analysis task
- task: SonarCloudAnalyze@4

# Publish Quality Gate Result task
- task: SonarCloudPublish@4
  inputs:
    pollingTimeoutSec: '300'

Using the Classic interface

To add the analysis to your classic build pipeline:

1. In Azure DevOps Classic interface editor, create or update your build pipeline.
2. Add a Prepare Analysis Configuration task before your build task:

   • In SonarQube Server Service Endpoint, select the SonarQube service connection you created during setup. See the Configuring project for Azure Pipelines page for more information about adding a connection.
   • Under Choose a way to run the analysis, select Integrate with .NET.
   • In the Project key field, enter your project key.
   • Optionally, enter the project name and version.
3. Add a new Run Code Analysis task after your build task.
4. Add a new Publish quality gate Result on your build pipeline summary.
5. Ensure that the pipeline runs automatically for all the branches you want:

   • Under the Triggers tab of your pipeline, select Enable continuous integration and select all the branches for which you want SonarQube Cloud analysis to run automatically.
6. Save your pipeline.

Configuring your scanner

If you're using the .NET scanner to complete the analysis, see the Configuring the scanner for NET page for language-specific details.

There's also an article about running Multi-language analysis for select languages when the sonar.scanner.scanAll parameter is enabled via the extraProperties listed in your Prepare Analysis Configuration task.

For a full explanation of how to pass properties to the SonarScanner for .NET, including when to use the /d: prefix versus bare properties in extraProperties, see Passing properties to the SonarScanner.

.Net guides on the Sonar Community forum

We’ve prepared some guides on the Community Forum to help you with your .NET project.

.NET Configuration

• Configuration of WarningAsErrors for .NET build
• Investigating the performance of .NET analysis

.NET and Code coverage

• Generate reports for C# and VB.net
• How to find logs about importing code coverage
• Troubleshooting guide for .NET Code coverage import

Related pages

• Gradle or Maven project

• C family project

• JS, TS, Go, Python, PHP, etc. project

• Monorepo projects

• List of SonarQube tasks