auxolotl/buildbot-nix
26
1
Fork 0
Code Issues Pull requests 1 Actions Packages Projects Releases Wiki Activity

README: mark github app experimental

Browse source
This commit is contained in:
Jörg Thalheim 2024-06-13 12:50:23 +02:00 committed by mergify[bot]
parent e6eaaef1f2
commit 383d759cce
1 changed files with 14 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -66,7 +66,20 @@ We have the following two roles:
### Integration with GitHub ### 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: 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 changes (new repositories or installations) automatically, it is therefore
necessary to manually trigger a reload or wait for the next periodic reload. 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 ### Optional when using GitHub login
1. **GitHub App**: Set up a GitHub app for Buildbot to enable GitHub user 1. **GitHub App**: Set up a GitHub app for Buildbot to enable GitHub user