paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 13 Packages Projects Releases Wiki Activity

Better GitHub scope/permission documentation

Browse Source 
Signed-off-by: Tim Hansen <timbonicus@gmail.com>
This commit is contained in:
Tim Hansen
2022-02-16 13:38:52 -07:00
parent ecbb373f59
commit 25889e1dea
2 changed files with 32 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins/github-apps.md
+16 -6
View File
@@ -109,11 +109,21 @@ privateKey: |
This will result in backstage preventing the use of any installation that is not
within the allow list.
### Permissions for pull requests
### App permissions
These are the minimum permissions required for creating a pull request with
Backstage software templates:
When creating a GitHub App, you must select permissions to define the level of
access for the app. The permissions required vary depending on your use of the
integration:
- Read and Write permissions for `Contents`.
- Read and write permissions for `Pull Requests` and `Issues`.
- Read permissions on `Metadata`.
- Reading software components:
- `Contents`: `Read-only`
- Reading organization data:
- `Members`: `Read-only`
- Publishing software templates:
- `Administration`: `Read & write` (for creating repositories)
- `Contents`: `Read & write`
- `Metadata`: `Read-only`
- `Pull requests`: `Read & write`
- `Issues`: `Read & write`
- `Workflows`: `Read & write` (if templates include GitHub workflows)