From dc4be86c75725649741e7fa1c37557062a3545e0 Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Thu, 25 Feb 2021 14:56:43 -0600 Subject: [PATCH] DOCS add note on PR decoration requiring analysis --- .../src/pages/analysis/azuredevops-integration.md | 3 ++- .../src/pages/analysis/bitbucket-integration.md | 8 +++----- .../sonar-docs/src/pages/analysis/github-integration.md | 8 +++----- .../sonar-docs/src/pages/analysis/gitlab-integration.md | 5 +++-- server/sonar-docs/src/pages/analysis/pull-request.md | 3 +++ 5 files changed, 14 insertions(+), 13 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md index ebfc4d2e8cd..644a235515d 100644 --- a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md +++ b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md @@ -258,7 +258,8 @@ After you've set up SonarQube to import your Azure DevOps repositories as shown Then, follow the steps in SonarQube to analyze your project. The project settings for pull request decoration are set automatically. -To set up a manually created or existing project or a project that's part of a mono repository, see the instructions in the following sections. +[[info]] +| 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**: diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md index 6c71ffe32b0..d85f2795a21 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md @@ -40,15 +40,13 @@ After saving your personal access token, you'll see a list of your Bitbucket Ser ## Adding pull request decoration to Bitbucket Server Pull request decoration shows your Quality Gate and analysis metrics directly in Bitbucket Server: -![pull request decoration](/images/github-branch-decoration.png) - -[[info]] -| 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. - After you've set up SonarQube to import your Bitbucket Server repositories as shown in the previous section, the simplest way to add pull request decoration is by adding a project from Bitbucket Server by clicking the **Add project** button in the upper-right corner of the **Projects** homepage and selecting **Bitbucket**. Then, follow the steps in SonarQube to analyze your project. The project settings for pull request decoration are set automatically. +[[info]] +| 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 configured as shown in the **Importing your Bitbucket Server repositories into SonarQube** section above, and set the following project settings at **Project Settings > General Settings > 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 9a9be35f3c6..fd1d78d89f1 100644 --- a/server/sonar-docs/src/pages/analysis/github-integration.md +++ b/server/sonar-docs/src/pages/analysis/github-integration.md @@ -74,15 +74,13 @@ Navigate to **Administration > Configuration > General Settings > ALM Integratio ## Adding pull request decoration to GitHub After creating and installing your GitHub App above, you can add pull request decoration to show your Quality Gate and analysis metrics directly in GitHub: -![pull request decoration](/images/github-branch-decoration.png) - -[[info]] -| 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. - The simplest way to add pull request decoration is by adding a project from GitHub by clicking the **Add project** button in the upper-right corner of the **Projects** homepage and selecting **GitHub**. Then, follow the steps in SonarQube to analyze your project. The project settings for pull request decoration are set automatically. +[[info]] +| 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, after you've created and installed your GitHub App and updated your global ALM Integration settings as shown in the **Importing your GitHub repositories into SonarQube** section above, set the following project settings at **Project Settings > General Settings > Pull Request Decoration**: diff --git a/server/sonar-docs/src/pages/analysis/gitlab-integration.md b/server/sonar-docs/src/pages/analysis/gitlab-integration.md index 28ddd1a2767..a3a99f24d0f 100644 --- a/server/sonar-docs/src/pages/analysis/gitlab-integration.md +++ b/server/sonar-docs/src/pages/analysis/gitlab-integration.md @@ -182,12 +182,13 @@ For more information on configuring your build with GitLab CI/CD, see the [GitLa Merge request decoration shows your Quality Gate and analysis metrics directly in GitLab: -![pull request decoration](/images/github-branch-decoration.png) - 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**. Then, follow the steps in SonarQube to analyze your project. The project settings for merge request decoration are set automatically. +[[info]] +| To decorate merge requests, a SonarQube analysis needs to be run on your code. You can find the additional parameters required for merge request analysis on the [Pull Request Analysis](/analysis/pull-request/) page. + ### 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**: diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md index aaa9f1abf11..54e23af0f94 100644 --- a/server/sonar-docs/src/pages/analysis/pull-request.md +++ b/server/sonar-docs/src/pages/analysis/pull-request.md @@ -22,6 +22,9 @@ You can also add pull request decoration that shows the Pull Request analysis an - [Bitbucket Server](/analysis/bitbucket-integration/) - [Azure DevOps](/analysis/azuredevops-integration/) +[[info]] +| 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 below in the **Analysis parameters** section. + ## Pull request Quality Gate A [Quality Gate](/user-guide/quality-gates/) lets you ensure you are meeting your organization's quality policy and that you can merge your pull request. The pull request uses your project Quality Gate as follows: -- 2.39.5