From 4cfacb67e2d0c47c374f211d62bcc77b08dcb17d Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Mon, 8 Feb 2021 07:39:22 -0600 Subject: [PATCH] SONAR-14423 Update ALM integration pages to include onboarding in CE --- .../src/pages/analysis/azuredevops-integration.md | 3 +++ .../src/pages/analysis/bitbucket-cloud-integration.md | 2 +- .../src/pages/analysis/bitbucket-integration.md | 3 +++ .../src/pages/analysis/github-integration.md | 10 ++++++---- .../src/pages/analysis/gitlab-integration.md | 3 +++ 5 files changed, 16 insertions(+), 5 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md index ba95c508fed..7b5fb5550e6 100644 --- a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md +++ b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md @@ -13,6 +13,9 @@ With this integration, you'll be able to: ## Prerequisites 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. + ## 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. diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md index beddf0a7ddb..63388d619a3 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md @@ -16,7 +16,7 @@ SonarScanners running in Bitbucket Pipelines can automatically detect branches o ### Activating builds Set up your build according to your SonarQube edition: -- **Community Edition** – Community Edition doesn't support multiple branches, so you should only analyze your main branch. You can restrict analysis to your main branch by using the `branches.master` pipeline in your `bitbucket-pipelines.yml` file and not using the `pull-requests` pipeline. +- **Community Edition** – Community Edition doesn't support multiple branches, so you should only analyze your main branch. You can restrict analysis to your main branch by setting it as the only branch in your `branches` pipeline in your `bitbucket-pipelines.yml` file and not using the `pull-requests` pipeline. - **Developer Edition and above** – Bitbucket Pipelines can build specific branches and pull requests if you use the `branches` and `pull-requests` pipelines as shown in the example configurations below. ### Setting environment variables diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md index 2e7d676a230..8e70a497b30 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md @@ -12,6 +12,9 @@ With this integration, you'll be able to: ## Prerequisites 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. + ## 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. diff --git a/server/sonar-docs/src/pages/analysis/github-integration.md b/server/sonar-docs/src/pages/analysis/github-integration.md index 7337f051161..e1f25aba179 100644 --- a/server/sonar-docs/src/pages/analysis/github-integration.md +++ b/server/sonar-docs/src/pages/analysis/github-integration.md @@ -14,11 +14,13 @@ With this integration, you'll be able to: ## Prerequisites To add pull request decoration to Checks in GitHub Enterprise, you must be running GitHub Enterprise version 2.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. + ## Importing your GitHub repositories to SonarQube -You need to use a GitHub App to connect SonarQube and GitHub so you can import your GitHub repositories into SonarQube. 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. +You need to use a GitHub App to connect SonarQube and GitHub so you can import your GitHub repositories into SonarQube. This is also the first step in adding authentication and, if you're using [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above, the first step in adding pull request decoration. -[[info]] -|If you're using Community Edition or want to set up authentication without importing your GitHub repositories, see the **Creating a dedicated app for authentication** section below for instructions on setting up authentication. +If you want to set up authentication without importing your GitHub repositories, see the **Creating a dedicated app for authentication** section below for instructions on setting up authentication. In this section, you'll complete the following steps to connect SonarQube and GitHub with a GitHub App: @@ -136,7 +138,7 @@ Navigate to **Administration > Configuration > General Settings > ALM Integratio Now, from the login page, your users can connect their GitHub accounts with the new "Log in with GitHub" button. ### Creating a dedicated app for authentication -If you're using Community Edition or you want to use a dedicated app for GitHub authentication, you can create a GitHub OAuth app. You'll find general instructions for creating a GitHub OAuth App [here](https://docs.github.com/en/free-pro-team@latest/developers/apps/creating-an-oauth-app). Specify the following settings in your OAuth App: +If you want to use a dedicated app for GitHub authentication, you can create a GitHub OAuth app. You'll find general instructions for creating a GitHub OAuth App [here](https://docs.github.com/en/free-pro-team@latest/developers/apps/creating-an-oauth-app). Specify the following settings in your OAuth App: - **Homepage URL** – the public URL of your SonarQube server. For example, `https://sonarqube.mycompany.com`. For security reasons, HTTP is not supported, and you must use HTTPS. The public URL is configured in SonarQube at **[Administration > General > Server base URL](/#sonarqube-admin#/admin/settings)**. - **Authorization callback URL** – your instance's base URL. For example, `https://yourinstance.sonarqube.com`. diff --git a/server/sonar-docs/src/pages/analysis/gitlab-integration.md b/server/sonar-docs/src/pages/analysis/gitlab-integration.md index 862fc3abcb2..cd00484baca 100644 --- a/server/sonar-docs/src/pages/analysis/gitlab-integration.md +++ b/server/sonar-docs/src/pages/analysis/gitlab-integration.md @@ -15,6 +15,9 @@ With this integration, you'll be able to: ## Prerequisites 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. + ## Authenticating with GitLab You can delegate authentication to GitLab using a dedicated GitLab OAuth application. -- 2.39.5