From 383d759ccec12cedb0875b731ba874cb4d489dea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Thu, 13 Jun 2024 12:50:23 +0200 Subject: [PATCH] README: mark github app experimental --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 234e7f9..df6adff 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,20 @@ We have the following two roles: ### Integration with GitHub -#### GitHub App +#### Token Auth + +To integrate with GitHub using legacy token authentication: + +1. **GitHub Token**: Obtain a GitHub token with `admin:repo_hook` and `repo` + permissions. For GitHub organizations, it's advisable to create a separate + GitHub user for managing repository webhooks. + +#### GitHub App (experimental) + +In the near future this will become the preferred way of integrating with +GitHub, After +[this issue](https://github.com/nix-community/buildbot-nix/issues/184) is +solved. To integrate with GitHub using app authentication: @@ -83,14 +96,6 @@ To integrate with GitHub using app authentication: changes (new repositories or installations) automatically, it is therefore necessary to manually trigger a reload or wait for the next periodic reload. -#### Legacy Token Auth - -To integrate with GitHub using legacy token authentication: - -1. **GitHub Token**: Obtain a GitHub token with `admin:repo_hook` and `repo` - permissions. For GitHub organizations, it's advisable to create a separate - GitHub user for managing repository webhooks. - ### Optional when using GitHub login 1. **GitHub App**: Set up a GitHub app for Buildbot to enable GitHub user