From 548bcaf0ebc3411557edf804fe3c6ef4ec902f99 Mon Sep 17 00:00:00 2001 From: cynthiabethea <108268296+cynthiabethea@users.noreply.github.com> Date: Mon, 22 Aug 2022 16:51:56 +0200 Subject: [PATCH] DOC-3 Renaming scanner extensions (#6507) --- .../src/pages/analysis/azuredevops-integration.md | 4 ++-- .../analysis/scan/sonarscanner-for-azure-devops.md | 10 +++++----- .../pages/analysis/scan/sonarscanner-for-jenkins.md | 4 ++-- .../analysis/test-coverage/dotnet-test-coverage.md | 13 ++++++------- 4 files changed, 15 insertions(+), 16 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md index 41ff90e9495..17a8428f437 100644 --- a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md +++ b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md @@ -7,7 +7,7 @@ SonarQube's integration with Azure DevOps allows you to maintain code quality an With this integration, you'll be able to: - **Import your Azure DevOps repositories** - Import your Azure DevOps repositories into SonarQube to easily set up SonarQube projects. -- **Analyze projects with Azure Pipelines** - Integrate analysis into your build pipeline. Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), SonarScanners running in Azure Pipelines jobs can automatically detect branches or pull requests being built, so you don't need to specifically pass them as parameters to the scanner. +- **Analyze projects with Azure Pipelines** - Integrate analysis into your build pipeline. Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), the SonarQube Extension running in Azure Pipelines jobs can automatically detect branches or pull requests being built, so you don't need to specifically pass them as parameters to the scanner. - **Report your Quality Gate status to your pull requests** - (starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html)) See your Quality Gate and code metric results right in Azure DevOps so you know if it's safe to merge your changes. ## Prerequisites @@ -43,7 +43,7 @@ After saving your personal access token, you'll see a list of your Azure DevOps For information on analyzing your projects with Azure Pipelines, see the **Analyzing projects with Azure Pipelines** section below. ## Analyzing projects with Azure Pipelines -SonarScanners running in Azure Pipelines jobs can automatically detect branches or pull requests being built, so you don't need to specifically pass them as parameters to the scanner. +The SonarQube Extension running in Azure Pipelines jobs can automatically detect branches or pull requests being built, so you don't need to specifically pass them as parameters to the scanner. [[info]] | Automatic branch detection is only available when using Git. diff --git a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md index a04748843a6..27f656233dc 100644 --- a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md @@ -1,5 +1,5 @@ --- -title: SonarScanner for Azure DevOps +title: SonarQube Extension for Azure DevOps url: /analysis/scan/sonarscanner-for-azure-devops/ --- @@ -11,17 +11,17 @@ url: /analysis/scan/sonarscanner-for-azure-devops/ | See the [online documentation](https://redirect.sonarsource.com/doc/download-scanner-azure.html) to get more details on the latest version of the scanner and how to download it. -The [SonarScanner for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube) makes it easy to integrate analysis into your build pipeline. The extension allows the analysis of all languages supported by SonarQube. +The [SonarQube Extension for Azure DevOps](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube) makes it easy to integrate analysis into your build pipeline. The extension allows the analysis of all languages supported by SonarQube. ## Compatibility -The SonarScanner for Azure DevOps 5.x is compatible with: +The SonarQube Extension for Azure DevOps 5.x is compatible with: * Azure DevOps Server 2019 (including _Express_ editions) * Azure DevOps Server 2020 (including _Express_ editions) * Azure DevOps Services -The SonarScanner for Azure DevOps 4.x is compatible with: +The SonarQube Extension for Azure DevOps 4.x is compatible with: * TFS 2017 Update 2+ (including _Express_ editions) * TFS 2018 (including _Express_ editions) ## Analysis -For information on setting up analysis with the SonarScanner for Azure DevOps, see the [Azure DevOps DevOps Platform integration](/analysis/azuredevops-integration/) page. +For information on setting up analysis with the SonarQube Extension for Azure DevOps, see the [Azure DevOps DevOps Platform integration](/analysis/azuredevops-integration/) page. diff --git a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-jenkins.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-jenkins.md index b17887ce1b5..27e3443a4f1 100644 --- a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-jenkins.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-jenkins.md @@ -1,5 +1,5 @@ --- -title: SonarScanner for Jenkins +title: Jenkins Extension for SonarQube url: /analysis/scan/sonarscanner-for-jenkins/ --- @@ -23,7 +23,7 @@ Then you can trigger SonarQube analysis from Jenkins using standard Jenkins Buil Once the job is complete, the plugin will detect that a SonarQube analysis was made during the build and display a badge and a widget on the job page with a link to the SonarQube dashboard as well as quality gate status. ## Installation -1. [Install the SonarScanner for Jenkins via the Jenkins Update Center](https://plugins.jenkins.io/sonar). +1. [Install the Jenkins Extension for SonarQube via the Jenkins Update Center](https://plugins.jenkins.io/sonar). 1. Configure your SonarQube server(s): 1. Log into Jenkins as an administrator and go to **Manage Jenkins > Configure System**. 1. Scroll down to the SonarQube configuration section, click **Add SonarQube**, and add the values you're prompted for. diff --git a/server/sonar-docs/src/pages/analysis/test-coverage/dotnet-test-coverage.md b/server/sonar-docs/src/pages/analysis/test-coverage/dotnet-test-coverage.md index 3d09583ec80..8d7e0917058 100644 --- a/server/sonar-docs/src/pages/analysis/test-coverage/dotnet-test-coverage.md +++ b/server/sonar-docs/src/pages/analysis/test-coverage/dotnet-test-coverage.md @@ -26,12 +26,11 @@ For information on the generic format, see [Generic Test Data](/analysis/generic ## Adding coverage to your build process The .NET scanner comes in four variants depending on which version of .NET and which CI you are using -(_.NET Framework_, _.NET Core_, _.NET tool_ and _SonarScanner for Azure DevOps_). +(_.NET Framework_, _.NET Core_, _.NET tool_ and _SonarQube Extension for Azure DevOps_). The setup is slightly different for each variant (see the [SonarScanner for .NET](/analysis/scan/sonarscanner-for-msbuild/) -and [SonarScanner for Azure DevOps](/analysis/scan/sonarscanner-for-azure-devops/) -sections for details), -but the essential steps are the same. +and [SonarQube Extension for Azure DevOps](/analysis/scan/sonarscanner-for-azure-devops/) +sections for details), but the essential steps are the same. The analysis is always split into two parts in your build process; the begin step and the end step. @@ -172,11 +171,11 @@ If you use the .NET Framework or .NET Core scanner, the commands will be a bit d See [SonarScanner for .NET](/analysis/scan/sonarscanner-for-msbuild/) for details. -## SonarScanner for Azure DevOps +## Extension for Azure Devops -Using the SonarScanner for Azure DevOps and Visual Studio Code Coverage with a C# project, your `azure-pipelines.yml` would look something like the example below. +Using the Extension for Azure Devops and Visual Studio Code Coverage with a C# project, your `azure-pipelines.yml` would look something like the example below. -Note that with the SonarScanner for Azure DevOps extension, the scanner `begin` step is handled by the `SonarQubePrepare` task and the scanner `end` step is handled by the `SonarQubeAnalyze` task. +Note that with the Extension for Azure Devops extension, the scanner `begin` step is handled by the `SonarQubePrepare` task and the scanner `end` step is handled by the `SonarQubeAnalyze` task. Also note that because our build is running on Windows (we specify `vmImage: windows-latest`), we do not need to explicitly specify the path to the coverage report (there is no `sonar.cs.vscoveragexml.reportsPaths=coverage.xml`) nor do you need to run `codecoverage.exe` to convert the report to XML. -- 2.39.5