From 0ebd8a28fd650bdd3d69d7f5fdbf96539c60e6bc Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 12 Apr 2024 17:24:00 +0200 Subject: [PATCH] docs/integration/github/discovery: mention require scope and permissions Signed-off-by: Patrik Oldsberg --- docs/integrations/github/discovery.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index fadf800335..93ab00146e 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -115,7 +115,7 @@ You can check the official docs to [configure your webhook](https://docs.github. ## Configuration To use the discovery provider, you'll need a GitHub integration -[set up](locations.md) with either a [Personal Access Token](../../getting-started/config/authentication.md) or [GitHub Apps](./github-apps.md). +[set up](locations.md) with either a [Personal Access Token](../../getting-started/config/authentication.md) or [GitHub Apps](./github-apps.md). For Personal Access Tokens you should pay attention to the [required scopes](https://backstage.io/docs/integrations/github/locations/#token-scopes), where you will need at least the `repo` scope for reading components. For GitHub Apps you will need to grant it the [required permissions](https://backstage.io/docs/integrations/github/github-apps#app-permissions) instead, where you will need at least the `Contents: Read-only` permissions for reading components. Then you can add a `github` config to the catalog providers configuration: