From 28f277c47eb71945543cca2de1e4f01677dd8742 Mon Sep 17 00:00:00 2001 From: colin-mueller-sonarsource Date: Tue, 17 Mar 2020 15:30:08 +0100 Subject: [PATCH] DOCS Pull Request cleanup: More ALMs --- .../sonar-docs/src/pages/analysis/pull-request.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md index 3bd88ad4681..7520d1c73b8 100644 --- a/server/sonar-docs/src/pages/analysis/pull-request.md +++ b/server/sonar-docs/src/pages/analysis/pull-request.md @@ -5,9 +5,9 @@ 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/)._ -You can see your Pull Requests in {instance} from the branches and pull requests dropdown menu of your project. +You can see your Pull Requests in SonarQube from the Branches and Pull Requests dropdown menu of your project. -Pull Request analysis allows you to see your Pull Request's Quality Gate and analysis in the {instance} interface: +Pull Request analysis allows you to see your Pull Request's Quality Gate and analysis in the SonarQube interface: ![Pull Request Analysis.](/images/pranalysis.png) @@ -17,10 +17,10 @@ You can also add Pull Request decoration that shows the Pull Request analysis an ## 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 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 or Failed. +* **Focuses on new code** – The Pull Request quality gate only uses your project's quality gate conditions that apply to "on New Code" metrics. +* **Assigns a status** – Each Pull Request shows a quality gate status reflecting whether it Passed or Failed. -PR analyses on {instance} are deleted automatically after 30 days with no analysis. This can be updated in **Administration > Configuration > General Settings > Housekeeping > Number of days before purging inactive branches**. +Pull Request analyses on SonarQube are deleted automatically after 30 days with no analysis. This can be updated in **Administration > Configuration > General Settings > Housekeeping > Number of days before purging inactive branches**. ## Analysis Parameters @@ -28,6 +28,6 @@ These parameters enable PR analysis: | Parameter Name | Description | | --------------------- | ---------------------------------- | -| `sonar.pullrequest.key` | Unique identifier of your PR. Must correspond to the key of the PR in GitHub or Azure DevOps.
e.g.: `sonar.pullrequest.key=5` | +| `sonar.pullrequest.key` | Unique identifier of your Pull Request. Must correspond to the key of the Pull Request in your ALM.
e.g.: `sonar.pullrequest.key=5` | | `sonar.pullrequest.branch` | The name of the branch that contains the changes to be merged.
e.g.: `sonar.pullrequest.branch=feature/my-new-feature` | -| `sonar.pullrequest.base` | The branch into which the PR will be merged.
Default: master
e.g.: `sonar.pullrequest.base=master` | +| `sonar.pullrequest.base` | The branch into which the Pull Request will be merged.
Default: master
e.g.: `sonar.pullrequest.base=master` | -- 2.39.5