Go to file
2024-05-02 04:29:28 +00:00
.github Bump cachix/install-nix-action from 25 to 26 2024-03-11 01:57:51 +00:00
bin add buildbot-effects 2023-12-26 21:54:20 +01:00
buildbot_effects fix new linting errors 2023-12-26 22:36:40 +01:00
buildbot_nix github: only include properties that we actually use for performance 2024-05-02 04:29:28 +00:00
examples example: add gitea section 2024-05-01 12:23:23 +02:00
nix make it possible to disable github 2024-04-30 17:32:40 +02:00
.gitignore also create webhooks automatically 2023-10-12 17:50:43 +02:00
.mergify.yml fix mergify configuration 2024-04-23 16:11:20 +02:00
default.nix add buildbot_nix as a python package to buildbot 2023-10-31 11:35:35 +01:00
flake.lock flake.lock: Update 2024-05-02 01:40:48 +00:00
flake.nix devshell: add mypy + ruff 2023-12-26 19:50:34 +01:00
pyproject.toml do merges locally 2024-04-06 18:54:58 +02:00
README.md master: add workaround if github is not present during boot 2024-04-29 18:16:10 +02:00

Buildbot-nix

Buildbot-nix is a NixOS module designed to integrate Buildbot, 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.

Getting Started with Buildbot Setup

To set up Buildbot using Buildbot-nix, you can start by exploring the provided examples:

Additionally, you can find real-world examples at the end of this document.

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. For a practical NixOS example, see this remote builder configuration.

Using Buildbot in Your Project

Buildbot-nix automatically triggers builds for your project under these conditions:

  • When a pull request is opened.
  • When a commit is pushed to the default git branch.

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.

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:

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. Set the callback url to https://<your-domain>/auth/login.
  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.

Binary caches

To access the build results on other machines there are two options at the moment

Local binary cache (harmonia)

You can set up a binary cache on your buildbot-worker machine to make its nix store accessible from other machines. Check out the README of the project, for an example configuration

Cachix

Buildbot-nix also supports pushing packages to cachix. Check out the comment out example configuration in our repository.

Real-World Deployments

See Buildbot-nix in action in these deployments: