You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by kl...@apache.org on 2022/07/21 13:48:13 UTC

[incubator-devlake-website] 01/01: docs: update github document for private repo

This is an automated email from the ASF dual-hosted git repository.

klesh pushed a commit to branch kw-lake-2472
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git

commit 9e199025ab6699371729302f07a3aa50ad2a573e
Author: Klesh Wong <zh...@merico.dev>
AuthorDate: Thu Jul 21 21:47:18 2022 +0800

    docs: update github document for private repo
    
      closes apache/incubator-devlake#2472
---
 docs/Plugins/github.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/Plugins/github.md b/docs/Plugins/github.md
index cca87b74..25a4e99b 100644
--- a/docs/Plugins/github.md
+++ b/docs/Plugins/github.md
@@ -42,6 +42,8 @@ The connection section of the configuration screen requires the following key fi
   - For help on **Creating a personal access token**, please see official [GitHub Docs on Personal Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
   - Provide at least one token for Authentication.
   - This field accepts a comma-separated list of values for multiple tokens. The data collection will take longer for GitHub since they have a **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour** (15,000 requests/hour if you pay for `GitHub` enterprise). You can accelerate the process by configuring _multiple_ personal access tokens.
+  - In order to collect data from your Private Repositories, the token must be granted with `repo` scope
+    ![repo scope](https://user-images.githubusercontent.com/61080/178412908-3ac9366b-80af-4a4d-a243-a9d598f1e6ac.png)
 
 Click **Save Connection** to update connection settings.