This is an automated email from the ASF dual-hosted git repository. yumeng pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 7cabb2e918ec92a597a0f6a29bdee8ccc1a9c9d9 Author: Klesh Wong <[email protected]> AuthorDate: Fri Sep 30 20:27:59 2022 +0800 docs: add private repo permission requirement Closes apache/incubator-devlake#2721 --- docs/UserManuals/ConfigUI/GitHub.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/UserManuals/ConfigUI/GitHub.md b/docs/UserManuals/ConfigUI/GitHub.md index aaae0da24..83a0491cb 100644 --- a/docs/UserManuals/ConfigUI/GitHub.md +++ b/docs/UserManuals/ConfigUI/GitHub.md @@ -16,7 +16,13 @@ This should be a valid REST API endpoint, eg. `https://api.github.com/`. The url #### Auth Token(s) GitHub personal access tokens are required to add a connection. -- Learn about [how to create a GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) +- Learn about [how to create a GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), the following permission are required for private repository: + - `repo:status` + - `repo_deployment` + - `public_repo` + - `repo:invite` + - `read:user` + - `read:org` - The data collection speed is relatively slow 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. Please note that multiple tokens should be created by different GitHub accounts. Tokens belonging to the same GitHub account share the rate limit. #### Proxy URL (Optional)
