From 647dc8cfd595d8cc6590a1f51aecf512a8b5786b Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl <47737412+michaelbirnstiehl@users.noreply.github.com> Date: Thu, 28 Feb 2019 09:39:12 +0100 Subject: [PATCH] DOC RQG updates to PR and SLB --- .../sonar-docs/src/pages/analysis/pull-request.md | 14 ++++++++------ .../src/pages/branches/short-lived-branches.md | 14 +++++--------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md index b79330d6860..80d25fc751b 100644 --- a/server/sonar-docs/src/pages/analysis/pull-request.md +++ b/server/sonar-docs/src/pages/analysis/pull-request.md @@ -8,19 +8,21 @@ url: /analysis/pull-request/ _Pull Request analysis is available as part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and [above](https://www.sonarsource.com/plans-and-pricing/)._ +Pull Requests (PRs) are visible in {instance} from the branches and pull requests dropdown menu of your project. +PR analysis allows you to: -Pull Request analysis allows you to: +* see your PR's Quality Gate status in the {instance} UI. +* automatically decorate your PRs with {instance} issues in your SCM provider's interface. -* see your Pull Request (PR) analysis results in the {instance} UI and see the green or red status to highlight the existence of open issues. -* automatically decorate your PRs with {instance} issues in your SCM provider's interface. +## Quality Gate -PRs are visible in {instance} from the "branches and pull requests" dropdown menu of your project. +The PR quality gate: +* **Focuses on new code** – The PR quality gate only uses your project's quality gate conditions that apply to "on New Code" metrics. +* **Assigns a status** – Each PR shows a quality gate status reflecting whether it Passed (green) or Failed (red). When PR decoration is enabled, {instance} publishes the status of the analysis (Quality Gate) on the PR. -When "Confirm", "Resolved as False Positive" or "Won't Fix" actions are performed on issues in {instance} UI, the status of the PR is updated accordingly. This means, if you want to get a green status on the PR, you can either fix the issues for real or "Confirm", "Resolved as False Positive" or "Won't Fix" any remaining issues available on the PR. - PR analyses on {instance} are deleted automatically after 30 days with no analysis. This can be updated in **Configuration > General > Number of days before purging inactive short living branches**. diff --git a/server/sonar-docs/src/pages/branches/short-lived-branches.md b/server/sonar-docs/src/pages/branches/short-lived-branches.md index e82747000a1..fb0ae07b45b 100644 --- a/server/sonar-docs/src/pages/branches/short-lived-branches.md +++ b/server/sonar-docs/src/pages/branches/short-lived-branches.md @@ -9,18 +9,14 @@ _Branch analysis is available as part of [Developer Edition](https://redirect.so -## Status vs Quality Gate +Short-lived branch analysis shows your analysis and quality gate status in the {instance} UI. -For short-lived branches, there is a kind of hard-coded quality gate focusing only on new issues. Its status is reflected by the green|red signal associated with each short-lived branch: +## Quality Gate -* status: green / OK or red / ERROR -* error conditions: - * new open bugs > 0 - * new open vulnerabilities > 0 - * new open code smells > 0 +The short-lived branch quality gate: -It is possible to change the status of a short-lived branch from ERROR to OK (red to green), i.e. mergable, by manually confirming the issues. The same is true for the False-Positive and Won't Fix statuses. -It means the status of a short-lived branch will be red only when there are Open issues in the branch. +* **Focuses on new code** – The short-lived branch quality gate only uses your project's quality gate conditions that apply to "on New Code" metrics. +* **Assigns a status** – Each short-lived branch shows a quality gate status reflecting whether it Passed (green) or Failed (red). ## Issue Creation and Synchronization -- 2.39.5