buildbot-nix/README.md

79 lines
3.3 KiB
Markdown
Raw Normal View History

2023-09-10 08:11:56 +00:00
# Buildbot-nix
2023-12-24 07:12:42 +00:00
Buildbot-nix is a NixOS module designed to integrate
[Buildbot](https://www.buildbot.net/), a continuous integration (CI) framework,
into the Nix ecosystem. This module is under active development, and while it's
generally stable and widely used, please be aware that some APIs may change over
time.
2023-09-10 08:11:56 +00:00
2023-12-24 07:12:42 +00:00
## Getting Started with Buildbot Setup
2023-09-14 09:11:10 +00:00
2023-12-24 07:12:42 +00:00
To set up Buildbot using Buildbot-nix, you can start by exploring the provided
examples:
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
- Check out the basic setup in [example](./examples/default.nix).
- Learn about configuring the Buildbot master in
[master module](./nix/master.nix).
- Understand how to set up a Buildbot worker in
[worker module](./nix/worker.nix).
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
Additionally, you can find real-world examples at the end of this document.
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
Buildbot masters and workers can be deployed either on the same machine or on
separate machines. To support multiple architectures, configure them as
[nix remote builders](https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds).
For a practical NixOS example, see
[this remote builder configuration](https://github.com/Mic92/dotfiles/blob/main/nixos/eve/modules/remote-builder.nix).
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
## Using Buildbot in Your Project
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
Buildbot-nix automatically triggers builds for your project under these
conditions:
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
- When a pull request is opened.
- When a commit is pushed to the default git branch.
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
It does this by evaluating the `.#checks` attribute of your project's flake in
parallel. Each attribute found results in a separate build step. You can test
these builds locally using `nix flake check -L` or
[nix-fast-build](https://github.com/Mic92/nix-fast-build).
2023-11-05 05:45:16 +00:00
2023-12-24 07:12:42 +00:00
If you need to build other parts of your flake, such as packages or NixOS
machines, you should re-export these into the `.#checks` output. Here are two
examples to guide you:
- Using
[flake-parts](https://github.com/Mic92/dotfiles/blob/10890601a02f843b49fe686d7bc19cb66a04e3d7/flake.nix#L139).
- A
[plain flake example](https://github.com/nix-community/nixos-images/blob/56b52791312edeade1e6bd853ce56c778f363d50/flake.nix#L53).
### Integration with GitHub
Buildbot-nix primarily supports GitHub, with plans to extend support to other
platforms like Gitea.
To integrate with GitHub:
1. **GitHub App**: Set up a GitHub app for Buildbot to enable GitHub user
authentication on the Buildbot dashboard.
2. **OAuth Credentials**: After installing the app, generate OAuth credentials
and configure them in the buildbot-nix NixOS module.
3. **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.
### Real-World Deployments
See Buildbot-nix in action in these deployments:
- **Nix-community infra**:
[Configuration](https://github.com/nix-community/infra/tree/master/modules/nixos)
| [Instance](https://buildbot.nix-community.org/)
- **Mic92's dotfiles**:
[Configuration](https://github.com/Mic92/dotfiles/blob/main/nixos/eve/modules/buildbot.nix)
| [Instance](https://buildbot.thalheim.io/)
- **Technical University Munich**:
[Configuration](https://github.com/TUM-DSE/doctor-cluster-config/tree/master/modules/buildbot)
| [Instance](https://buildbot.dse.in.tum.de/)
- **Numtide**: [Instance](https://buildbot.numtide.com)