aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenoit <43733395+benoit-sns@users.noreply.github.com>2018-12-06 09:28:14 +0100
committerSonarTech <sonartech@sonarsource.com>2018-12-06 20:21:00 +0100
commit4eb2f9bc75fc56295d4345c2a1272c0e0b438738 (patch)
tree2e2a262ab5c1611965f52195b4dee2a60a5ccd02
parent41c98779d38bda9fdfdca182a5f20c73fcff9a84 (diff)
downloadsonarqube-4eb2f9bc75fc56295d4345c2a1272c0e0b438738.tar.gz
sonarqube-4eb2f9bc75fc56295d4345c2a1272c0e0b438738.zip
DOC Update PR decoration doc for SC
-rw-r--r--server/sonar-docs/src/pages/analysis/pull-request.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md
index 106d91bf4c4..2734bdb5446 100644
--- a/server/sonar-docs/src/pages/analysis/pull-request.md
+++ b/server/sonar-docs/src/pages/analysis/pull-request.md
@@ -46,9 +46,13 @@ To activate PR decoration, you need to:
* feed some specific parameters (GitHub only)
#### Authentication Token
-The first thing to configure is the authentication token that will be used by {instance} to decorate the PRs. This can be configured in **Administration > Pull Requests**. The field to configure depends on the provider.
-
+<!-- sonarqube -->
+The first thing to configure is the authentication token that will be used by {instance} to decorate the PRs. This can be configured in **Administration > General Settings > Pull Requests**. The field to configure depends on the provider.
For GitHub Enterprise or GitHub.com, you need to configure the **Authentication token** field. For Azure DevOps, it's the **Personal access token**.
+<!-- /sonarqube -->
+<!-- sonarcloud -->
+If you are using Azure DevOps, the first thing to configure is the authentication token that will be used by {instance} to decorate the PRs. This can be configured in **Administration > General Settings > Pull Requests > VSTS > Personal access token**.
+<!-- /sonarcloud -->
#### Pull Request Provider
| Parameter Name | Description |
@@ -59,7 +63,9 @@ For GitHub Enterprise or GitHub.com, you need to configure the **Authentication
| Parameter Name | Description |
| --------------------- | ------------------ |
| `sonar.pullrequest.github.repository` | SLUG of the GitHub Repo |
+<!-- sonarqube -->
| `sonar.pullrequest.github.endpoint` | The API url for your GitHub instance.<br/> Ex.: `https://api.github.com/` or `https://github.company.com/api/v3/` |
+<!-- /sonarqube -->
Note: if you were relying on the GitHub Plugin, its properties are no longer required and they must be removed from your configuration: `sonar.analysis.mode`, `sonar.github.repository`, `sonar.github.pullRequest`, `sonar.github.oauth`.