diff options
| author | michaelbirnstiehl <michael.birnstiehl@sonarsource.com> | 2020-09-09 16:27:25 -0500 |
|---|---|---|
| committer | sonartech <sonartech@sonarsource.com> | 2020-09-10 20:07:30 +0000 |
| commit | 74393e4e8b46177475088aae7539c57c941ee963 (patch) | |
| tree | e3f03bde959a3953508ea9d82f28db9f8bdb3bff /server/sonar-docs/src/pages/analysis/pull-request.md | |
| parent | 2df7f4b240c75e72c91360010bbeddfd1a70cc73 (diff) | |
| download | sonarqube-74393e4e8b46177475088aae7539c57c941ee963.tar.gz sonarqube-74393e4e8b46177475088aae7539c57c941ee963.zip | |
SONAR-13787 Clarify the PR analysis process
Diffstat (limited to 'server/sonar-docs/src/pages/analysis/pull-request.md')
| -rw-r--r-- | server/sonar-docs/src/pages/analysis/pull-request.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md index cd4f237a782..5205ac7c080 100644 --- a/server/sonar-docs/src/pages/analysis/pull-request.md +++ b/server/sonar-docs/src/pages/analysis/pull-request.md @@ -5,12 +5,16 @@ url: /analysis/pull-request/ _Pull Request analysis is available starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html)._ -You can see your Pull Requests in SonarQube 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 SonarQube interface: +Pull Request analysis shows your Pull Request's Quality Gate and analysis in the SonarQube interface. This analysis shows new issues introduced by the Pull Request before merging with the target branch:  +## Prerequisites + +Before analyzing your Pull Requests, make sure the Pull Request branch is checked out. Avoid any attempt at previewing the merge or actions involving your main branch. + ## Pull Request Decoration You can also add Pull Request decoration that shows the Pull Request analysis and Quality Gate directly in your ALM's interface. See [Decorating Pull Requests](/analysis/pr-decoration/) for more information on setting it up. @@ -33,4 +37,4 @@ The following parameters enable PR analysis. | --------------------- | ---------------------------------- | | `sonar.pullrequest.key` | Unique identifier of your Pull Request. Must correspond to the key of the Pull Request in your ALM.<br/> e.g.: `sonar.pullrequest.key=5` | | `sonar.pullrequest.branch` | The name of the branch that contains the changes to be merged.<br/> e.g.: `sonar.pullrequest.branch=feature/my-new-feature` | -| `sonar.pullrequest.base` | The branch into which the Pull Request will be merged. <br/> Default: master <br/> e.g.: `sonar.pullrequest.base=master` | +| `sonar.pullrequest.base` | The branch into which the Pull Request will be merged. <br/> Default: master <br/> e.g.: `sonar.pullrequest.base=master` |
\ No newline at end of file |