Better GitHub scope/permission documentation

Signed-off-by: Tim Hansen <timbonicus@gmail.com>
2022-02-16 13:38:52 -07:00
parent ecbb373f59
commit 25889e1dea
2 changed files with 32 additions and 6 deletions
@@ -57,6 +57,22 @@ public GitHub, for which we can infer them). The `apiBaseUrl` will always be
 preferred over the other if a `token` is given, otherwise `rawBaseUrl` will be
 preferred.

+### Token scopes
+
+When creating a personal access token on GitHub, you must select scopes to
+define the level of access for the token. The scopes required vary depending on
+your use of the integration:
+
+- Reading software components:
+  - `repo`
+- Reading organization data:
+  - `read:org`
+  - `read:user`
+  - `user:email`
+- Publishing software templates:
+  - `repo`
+  - `workflow` (if templates include GitHub workflows)
+
 ## Authentication with GitHub Apps

 Alternatively, Backstage can use GitHub Apps for backend authentication. This