]> source.dussan.org Git - sonarqube.git/commitdiff
DOCS Add email permission in documentation for GitHub Authentication
authorJoe Tingsanchali <joe.tingsanchali@sonarsource.com>
Mon, 15 Feb 2021 20:00:34 +0000 (14:00 -0600)
committersonartech <sonartech@sonarsource.com>
Tue, 16 Feb 2021 20:07:08 +0000 (20:07 +0000)
server/sonar-docs/src/pages/analysis/github-integration.md

index 05c3ef9167fb2c676786d48208f02d9d43db6b0a..93f36bfa2b863397e5494ffca7a7b603c6bd146b 100644 (file)
@@ -39,12 +39,17 @@ Specify the following settings in your app:
 - **Webhook URL** – Your instance's base URL. For example, `https://yourinstance.sonarqube.com`.
 - Grant access for the following **Repository permissions**:
 
-   | Permission          | Access       |
-   |---------------------|--------------|
-   | Checks              | Read & write |
-   | **GitHub Enterprise:** Repository metadata <br> **GitHub.com:** Metadata <br> (this setting is automatically set by GitHub)| Read-only |
-   | Pull Requests       | Read & write |
-   | Commit statuses     | Read-only    |
+  | Permission          | Access       |
+  |---------------------|--------------|
+  | Checks              | Read & write |
+  | **GitHub Enterprise:** Repository metadata <br> **GitHub.com:** Metadata <br> (this setting is automatically set by GitHub)| Read-only |
+  | Pull Requests       | Read & write |
+  | Commit statuses     | Read-only    |
+- If setting up **GitHub Authentication**, grant access for the following **User permissions**:
+
+  | Permission          | Access       |
+  |---------------------|--------------|
+  | Email addresses     | Read-only    |
 
 - Under "Where can this GitHub App be installed?," select **Any account**.
 
@@ -149,4 +154,4 @@ Navigate to **Administration > Configuration > General Settings > ALM Integratio
 1. **Client ID** – the Client ID is found below the GitHub App ID on your GitHub App's page.
 1. **Client Secret** – the Client secret is found below the Client ID on your GitHub App's page.
   
-Now, from the login page, your users can connect their GitHub accounts with the new "Log in with GitHub" button.
\ No newline at end of file
+Now, from the login page, your users can connect their GitHub accounts with the new "Log in with GitHub" button.