From: michaelbirnstiehl Date: Tue, 9 Mar 2021 20:16:36 +0000 (-0600) Subject: SONAR-14569 Document ALM Main Branch detection upon onboarding X-Git-Tag: 8.8.0.42792~37 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c84c568afd9068486e86ca57c267dfc3271c07f8;p=sonarqube.git SONAR-14569 Document ALM Main Branch detection upon onboarding --- diff --git a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md index 249030dcb63..51a8c3c52f6 100644 --- a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md +++ b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md @@ -14,7 +14,7 @@ With this integration, you'll be able to: Integration with Azure DevOps server requires at least Azure DevOps Server 2019, TFS 2018, or TFS 2017 Update 2+. ### Branch Analysis -Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. With [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests. +Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests. ## Importing your Azure DevOps repositories into SonarQube Setting up the import of Azure DevOps repositories into SonarQube allows you to easily create SonarQube projects from your Azure DevOps repositories. If you're using [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above, this is also the first step in adding pull request decoration. @@ -38,7 +38,7 @@ Then, you'll be asked to provide a personal access token with `Code (Read & Writ After saving your personal access token, you'll see a list of your Azure DevOps projects that you can **set up** to add them to SonarQube. Setting up your projects this way also sets your project settings for pull request decoration. -For information on analyzing your projects with Azure Pipelines, see the following section. +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. @@ -306,13 +306,14 @@ Then, follow the steps in SonarQube to analyze your project. The project setting | To decorate Pull Requests, a SonarQube analysis needs to be run on your code. You can find the additional parameters required for Pull Request analysis on the [Pull Request Analysis](/analysis/pull-request/) page. ### Adding pull request decoration to a manually created or existing project -To add pull request decoration to a manually created or existing project, make sure your global ALM Integration settings are set as shown above in the **Importing your Azure DevOps repositories into SonarQube** section, and set the following project settings at **Project Settings > General Settings > Pull Request Decoration**: - -From here, set your: +To add pull request decoration to a manually created or existing project, make sure your global ALM Integration settings are set as shown above in the **Importing your Azure DevOps repositories into SonarQube** section, and set the following project settings at **Project Settings > General Settings > Pull Request Decoration**: - **Project name** - **Repository name** +[[info]] +| If you add your project manually, your main branch defaults to the name "master". You can rename it from the project settings at **Administration > Branches and Pull Requests**. + ### Advanced pull request decoration configuration [[collapse]] diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md index d85f2795a21..1f20eb32235 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md @@ -13,7 +13,7 @@ With this integration, you'll be able to: Integration with Bitbucket Server requires at least Bitbucket Server version 5.15. ### Branch Analysis -Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. With [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests. +Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests. ## Importing your Bitbucket Server repositories into SonarQube Setting up the import of BitBucket Server repositories into SonarQube allows you to easily create SonarQube projects from your Bitbucket Server repositories. If you're using [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above, this is also the first step in adding pull request decoration. @@ -54,6 +54,9 @@ To add pull request decoration to a manually created or existing project, make s - **Project Key** – the project key is part of your BitBucket Server repository URL (.../projects/**{KEY}**/repos/{SLUG}/browse). - **Repository SLUG** – The repository slug is part of your BitBucket Server repository URL (.../projects/{KEY}/repos/**{SLUG}**/browse). +[[info]] +| If you add your project manually, your main branch defaults to the name "master". You can rename it from the project settings at **Administration > Branches and Pull Requests**. + ### Advanced pull request decoration configuration [[collapse]] diff --git a/server/sonar-docs/src/pages/analysis/github-integration.md b/server/sonar-docs/src/pages/analysis/github-integration.md index fd1d78d89f1..0bc200266c3 100644 --- a/server/sonar-docs/src/pages/analysis/github-integration.md +++ b/server/sonar-docs/src/pages/analysis/github-integration.md @@ -87,6 +87,9 @@ To add pull request decoration to a manually created or existing project, after - **Configuration name** – The configuration name that corresponds to your GitHub instance. - **Repository identifier** – The path of your repository URL. +[[info]] +| If you add your project manually, your main branch defaults to the name "master". You can rename it from the project settings at **Administration > Branches and Pull Requests**. + ### Advanced pull request decoration configuration [[collapse]] diff --git a/server/sonar-docs/src/pages/analysis/gitlab-integration.md b/server/sonar-docs/src/pages/analysis/gitlab-integration.md index d17b549a424..c3f6634f8d5 100644 --- a/server/sonar-docs/src/pages/analysis/gitlab-integration.md +++ b/server/sonar-docs/src/pages/analysis/gitlab-integration.md @@ -16,7 +16,7 @@ With this integration, you'll be able to: Integration with GitLab Self-Managed requires at least GitLab Self-Managed version 11.7. ### Branch Analysis -Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. With [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests. +Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests. ## Authenticating with GitLab You can delegate authentication to GitLab using a dedicated GitLab OAuth application. @@ -186,7 +186,7 @@ For more information on configuring your build with GitLab CI/CD, see the [GitLa ## Adding merge request decoration to GitLab -Merge request decoration shows your Quality Gate and analysis metrics directly in GitLab: +Merge request decoration shows your Quality Gate and analysis metrics directly in GitLab. After you've set up SonarQube to import your GitLab projects as shown in the previous section, the simplest way to add merge request decoration is by adding a project from GitLab by clicking the **Add project** button in the upper-right corner of the **Projects** homepage and selecting **GitLab**. @@ -198,10 +198,12 @@ Then, follow the steps in SonarQube to analyze your project. The project setting ### Adding merge request decoration to a manually created or existing project To add merge request decoration to a manually created or existing project, make sure your global ALM Integration settings are set as shown in the **Importing your GitLab projects into SonarQube** section above, and set the following project settings at **Project Settings > General Settings > Pull Request Decoration**: -From here, set your: - **Configuration name** – The configuration name that corresponds to your GitLab instance. - **Project ID** – your GitLab Project ID found in GitLab +[[info]] +| If you add your project manually, your main branch defaults to the name "master". You can rename it from the project settings at **Administration > Branches and Pull Requests**. + ### Advanced merge request decoration configuration [[collapse]] @@ -231,4 +233,4 @@ From here, set your: [[collapse]] | ## Linking issues -| During pull request decoration, individual issues will be linked to their SonarQube counterparts automatically. For this to work correctly, you need to set the instance's **Server base URL** (**[Administration > Configuration > General Settings > General > General](/#sonarqube-admin#/admin/settings/)**) correctly. Otherwise, the links will default to `localhost`. +| During merge request decoration, individual issues will be linked to their SonarQube counterparts automatically. For this to work correctly, you need to set the instance's **Server base URL** (**[Administration > Configuration > General Settings > General > General](/#sonarqube-admin#/admin/settings/)**) correctly. Otherwise, the links will default to `localhost`. \ No newline at end of file diff --git a/server/sonar-docs/src/pages/branches/overview.md b/server/sonar-docs/src/pages/branches/overview.md index 83c2660114f..efcaa71fb84 100644 --- a/server/sonar-docs/src/pages/branches/overview.md +++ b/server/sonar-docs/src/pages/branches/overview.md @@ -11,7 +11,11 @@ With Branch Analysis, you can ensure that you're maintaining consistent code qua ### Master / Main Branch -This is the default branch and typically corresponds to what's being developed for your next release. This is usually known within a development team as "master" or "head" and is analyzed when no specific branch parameters are provided. It is labeled "Main Branch" and defaults to the name "master" but can be renamed from the project settings at **Administration > Branches and Pull Requests**. When you are using Community Edition, this is the only branch you see. +This is the default branch and typically corresponds to what's being developed for your next release. This branch is usually known within a development team as "master" or "head" and is analyzed when no specific branch parameters are provided. SonarQube labels this branch as **Main Branch**, and, with Community Edition, this is the only branch you can analyze. + +If you add your project from an ALM, your main branch name in SonarQube matches your main branch name in your repository. See **ALM Integrations** in the documentation navigation for more information on adding your project from an ALM. + +If you add your project manually, your main branch defaults to the name "master" but can be renamed from the project settings at **Administration > Branches and Pull Requests**. ### Settings and Quality Profiles on Branches