You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by yu...@apache.org on 2023/02/14 16:05:23 UTC
[incubator-devlake-website] branch main updated: fix: add token permission for private repos (#435)
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
The following commit(s) were added to refs/heads/main by this push:
new 6b372af93a fix: add token permission for private repos (#435)
6b372af93a is described below
commit 6b372af93ac9d71c3169a20a56690dc4a79f774e
Author: Louis.z <lo...@gmail.com>
AuthorDate: Wed Feb 15 00:05:17 2023 +0800
fix: add token permission for private repos (#435)
Co-authored-by: Startrekzky <ka...@merico.dev>
---
docs/Configuration/GitHub.md | 8 ++++++++
versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md | 8 ++++++++
2 files changed, 16 insertions(+)
diff --git a/docs/Configuration/GitHub.md b/docs/Configuration/GitHub.md
index eff040331a..b903a9d294 100644
--- a/docs/Configuration/GitHub.md
+++ b/docs/Configuration/GitHub.md
@@ -31,6 +31,14 @@ Learn about [how to create a GitHub personal access token](https://docs.github.c
- `read:user`
- `read:org`
+However, if you want to collect data from private repositories, the following permissions are required:
+
+- `repo`
+- `read:user`
+- `read:org`
+
+The difference is that you have to give full permission for `repos`, not just `repo:status` and `repo_deployment`.
+
The data collection speed is restricted by the **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour per token** (15,000 requests/hour if you pay for GitHub enterprise). You can accelerate data collection 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.
###### Fine-grained personal access tokens
diff --git a/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md b/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md
index c80152260f..d73628519a 100644
--- a/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md
+++ b/versioned_docs/version-v0.15/UserManuals/ConfigUI/GitHub.md
@@ -31,6 +31,14 @@ Learn about [how to create a GitHub personal access token](https://docs.github.c
- `read:user`
- `read:org`
+However, if you want to collect data from private repositories, the following permissions are required:
+
+- `repo`
+- `read:user`
+- `read:org`
+
+The difference is that you have to give full permission for `repos`, not just `repo:status` and `repo_deployment`.
+
The data collection speed is restricted by the **rate limit of [5,000 requests](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) per hour per token** (15,000 requests/hour if you pay for GitHub enterprise). You can accelerate data collection 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.
###### Fine-grained personal access tokens