lix-project/buildbot-nix
15
0
Fork 0
Code Issues 9 Pull requests 4 Packages Projects Releases Wiki Activity

document github support

Browse source
This commit is contained in:
Jörg Thalheim 2023-11-05 06:45:16 +01:00 committed by mergify[bot]
parent 1679eadca6
commit 7998338b3b
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -6,3 +6,23 @@ For an example checkout the [example](./examples/default.nix) and the module
descriptions for [master](./nix/master.nix) and [worker](./nix/worker.nix).
This project is still in early stage and many APIs might change over time.
## Github
We currently primarly support Github as a platform but we are also looking into
supporting other CIs such as gitea.
Buildbot requires a GitHub app, to allow login for GitHub users to its
dashboard.
Furthermore buildbot requires a github token with the following permissions:
- `admin:repo_hook`, `public_repo`, `repo:status`
For github organisations it's recommend to create an additional GitHub user for
that.
## Real-worlds deployments
- [Nix-community infra](https://github.com/nix-community/infra/tree/master/modules/nixos)
- [Mic92's dotfiles](https://github.com/Mic92/dotfiles/blob/main/nixos/eve/modules/buildbot.nix)