This is an automated email from the ASF dual-hosted git repository.
klesh 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 6fb221faebe docs: add warnings for GitHub app (#786)
6fb221faebe is described below
commit 6fb221faebe5cd83b32e77b06439972d06772ca1
Author: Louis.z <[email protected]>
AuthorDate: Wed Sep 18 11:49:48 2024 +0800
docs: add warnings for GitHub app (#786)
Co-authored-by: Startrekzky <[email protected]>
---
docs/Configuration/GitHub.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/docs/Configuration/GitHub.md b/docs/Configuration/GitHub.md
index 8af9b255605..9191edc0914 100644
--- a/docs/Configuration/GitHub.md
+++ b/docs/Configuration/GitHub.md
@@ -60,7 +60,13 @@ The token should be granted read-only permission for the
following entities.
- `Pull requests`
-##### GitHub Apps
+##### GitHub Apps (beta)
+:::caution
+
+The GitHub App token expires every hour and does not auto-renew. To collect
data from large repositories, please use the [Personal Access
Token](#github-personal-access-tokensrecommended) for authentication.
+
+:::
+
Learn about [how to create a GitHub
Apps](https://docs.github.com/en/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings).
The following permissions are required to collect data from repositories:
- Repository
- Actions
