2023-09-10 08:11:56 +00:00
|
|
|
# Buildbot-nix
|
|
|
|
|
2023-12-15 09:29:12 +00:00
|
|
|
A nixos module to make [buildbot](https://www.buildbot.net/) a proper Nix-CI.
|
2023-09-10 08:11:56 +00:00
|
|
|
|
2023-09-18 13:14:45 +00:00
|
|
|
For an example checkout the [example](./examples/default.nix) and the module
|
|
|
|
descriptions for [master](./nix/master.nix) and [worker](./nix/worker.nix).
|
2023-09-14 09:11:10 +00:00
|
|
|
|
|
|
|
This project is still in early stage and many APIs might change over time.
|
2023-11-05 05:45:16 +00:00
|
|
|
|
|
|
|
## 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
|
2023-11-12 07:54:54 +00:00
|
|
|
dashboard. After installing the app, create oauth credentials and set them in
|
|
|
|
the buildbot-nix nixos module.
|
2023-11-05 05:45:16 +00:00
|
|
|
|
|
|
|
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)
|