You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by ab...@apache.org on 2023/11/27 03:26:07 UTC
(incubator-devlake-website) branch fix-github-job-name-not-match updated: docs: add github apps permissions
This is an automated email from the ASF dual-hosted git repository.
abeizn pushed a commit to branch fix-github-job-name-not-match
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/fix-github-job-name-not-match by this push:
new 43dcadf861 docs: add github apps permissions
43dcadf861 is described below
commit 43dcadf8617217c49c21e7089e792c58947c30a3
Author: abeizn <zi...@merico.dev>
AuthorDate: Mon Nov 27 11:25:56 2023 +0800
docs: add github apps permissions
---
docs/Configuration/GitHub.md | 17 +++++++++++++++++
versioned_docs/version-v0.18/Configuration/GitHub.md | 15 +++++++++++++++
versioned_docs/version-v0.19/Configuration/GitHub.md | 15 +++++++++++++++
versioned_docs/version-v0.20/Configuration/GitHub.md | 15 +++++++++++++++
4 files changed, 62 insertions(+)
diff --git a/docs/Configuration/GitHub.md b/docs/Configuration/GitHub.md
index 2b827ec8a4..d38d3454fc 100644
--- a/docs/Configuration/GitHub.md
+++ b/docs/Configuration/GitHub.md
@@ -59,6 +59,23 @@ The token should be granted read-only permission for the following entities.
- `Metadata`
- `Pull requests`
+
+##### GitHub Apps
+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
+ - Administration
+ - Checks
+ - Commit statuses
+ - Contents
+ - Deployments
+ - Issues
+ - Metadata
+ - Pull requests
+- Organization
+ - Members
+
+
#### Use Graphql APIs
If you are using `github.com` or your on-premise GitHub version supports GraphQL APIs, toggle on this setting to collect data quicker.
diff --git a/versioned_docs/version-v0.18/Configuration/GitHub.md b/versioned_docs/version-v0.18/Configuration/GitHub.md
index a4cf8c737d..5c78a517eb 100644
--- a/versioned_docs/version-v0.18/Configuration/GitHub.md
+++ b/versioned_docs/version-v0.18/Configuration/GitHub.md
@@ -59,6 +59,21 @@ The token should be granted read-only permission for the following entities.
- `Metadata`
- `Pull requests`
+##### GitHub Apps
+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
+ - Administration
+ - Checks
+ - Commit statuses
+ - Contents
+ - Deployments
+ - Issues
+ - Metadata
+ - Pull requests
+- Organization
+ - Members
+
#### Use Graphql APIs
If you are using `github.com` or your on-premise GitHub version supports GraphQL APIs, toggle on this setting to collect data quicker.
diff --git a/versioned_docs/version-v0.19/Configuration/GitHub.md b/versioned_docs/version-v0.19/Configuration/GitHub.md
index a4cf8c737d..5c78a517eb 100644
--- a/versioned_docs/version-v0.19/Configuration/GitHub.md
+++ b/versioned_docs/version-v0.19/Configuration/GitHub.md
@@ -59,6 +59,21 @@ The token should be granted read-only permission for the following entities.
- `Metadata`
- `Pull requests`
+##### GitHub Apps
+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
+ - Administration
+ - Checks
+ - Commit statuses
+ - Contents
+ - Deployments
+ - Issues
+ - Metadata
+ - Pull requests
+- Organization
+ - Members
+
#### Use Graphql APIs
If you are using `github.com` or your on-premise GitHub version supports GraphQL APIs, toggle on this setting to collect data quicker.
diff --git a/versioned_docs/version-v0.20/Configuration/GitHub.md b/versioned_docs/version-v0.20/Configuration/GitHub.md
index 2b827ec8a4..da95d0a60c 100644
--- a/versioned_docs/version-v0.20/Configuration/GitHub.md
+++ b/versioned_docs/version-v0.20/Configuration/GitHub.md
@@ -59,6 +59,21 @@ The token should be granted read-only permission for the following entities.
- `Metadata`
- `Pull requests`
+##### GitHub Apps
+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
+ - Administration
+ - Checks
+ - Commit statuses
+ - Contents
+ - Deployments
+ - Issues
+ - Metadata
+ - Pull requests
+- Organization
+ - Members
+
#### Use Graphql APIs
If you are using `github.com` or your on-premise GitHub version supports GraphQL APIs, toggle on this setting to collect data quicker.