aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs
diff options
context:
space:
mode:
authorcolin-mueller-sonarsource <44168128+colin-mueller-sonarsource@users.noreply.github.com>2019-06-26 13:50:30 -0700
committersonartech <sonartech@sonarsource.com>2019-06-28 08:45:55 +0200
commite129e2b2aad841786f8638a75c7a4bffc23fdb38 (patch)
treeeaed8a52f791ff9c31a33911e01a20d51ca261b9 /server/sonar-docs
parentea1891b2d5c87f468598fee34785841204346218 (diff)
downloadsonarqube-e129e2b2aad841786f8638a75c7a4bffc23fdb38.tar.gz
sonarqube-e129e2b2aad841786f8638a75c7a4bffc23fdb38.zip
Document Additional Permissions for GitHub Checks
Diffstat (limited to 'server/sonar-docs')
-rw-r--r--server/sonar-docs/src/pages/instance-administration/github-application.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/server/sonar-docs/src/pages/instance-administration/github-application.md b/server/sonar-docs/src/pages/instance-administration/github-application.md
index 5d144bdab79..57fe93fda37 100644
--- a/server/sonar-docs/src/pages/instance-administration/github-application.md
+++ b/server/sonar-docs/src/pages/instance-administration/github-application.md
@@ -16,7 +16,15 @@ From the "Register new GitHub App" page, follow these steps to create your GitHu
1. Under **GitHub App name**, give your app a name (such as SonarQubePRChecks).
2. GitHub requires a **Homepage URL** and a **Webhook URL**. These values aren't important for Pull Request decoration, so you can use any URL (such as https://www.sonarqube.org/).
-3. Under "Permissions" set **Checks** to **Read & write**.
+3. Grant access for the following **Permissions**
+
+ | Permission | Access |
+ |---------------------|--------------|
+ | Checks | Read & write |
+ | Repository metadata | Read-only |
+ | Pull Requests | Read-only |
+ | Commit statuses | Read-only |
+
4. Under "Where can this GitHub App be installed?," select **Any account**.
5. Click **Create GitHub App**.