From 6a9394bed5fbdf822402c0ea109b2ac1447804b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Wed, 12 Jun 2024 09:05:36 +0200 Subject: [PATCH] document permissions required for github app --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 820486e..fad8ac7 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,11 @@ We have the following two roles: To integrate with GitHub using app authentication: 1. **GitHub App**: Set up a GitHub app for Buildbot to enable GitHub user - authentication on the Buildbot dashboard. + authentication on the Buildbot dashboard. Enable the following permissions: + - Contents: Read-only + - Metadata: Read-only + - Commit statuses: Read and write + - Webhooks: Read and write 2. **GitHub App private key**: Get the app private key and app ID from GitHub, configure using the buildbot-nix NixOS module. 3. **Install App**: Install the app for an organization or specific user.