auxolotl/buildbot-nix
26
1
Fork 0
Code Issues Pull requests 1 Actions 1 Packages Projects Releases Wiki Activity
210 commits 4 branches 0 tags 468 KiB
Python 74.9%
Nix 25.1%
Go to file
github-actions[bot] e2eadbb009 flake.lock: Update 
Flake lock file updates:

• Updated input 'nixpkgs':
    'github:Nixos/nixpkgs/66e2e75c671f9a674a28d340e59a0157efb6f905' (2024-03-20)
  → 'github:Nixos/nixpkgs/fc7ec5e349440957a173a4346734dee8baf6a7d1' (2024-03-23)
2024-03-24 01:42:48 +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 fix users not beeing able to restart virtual builders 2024-03-07 22:58:37 +01:00
examples Improve readme 2023-12-24 07:51:41 +00:00
nix re-introduce buildbot patch for old buildbot versions 2024-03-21 10:50:37 +01:00
.gitignore also create webhooks automatically 2023-10-12 17:50:43 +02:00
.mergify.yml add mergify 2023-10-12 23:59:45 +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-03-24 01:42:48 +00:00
flake.nix devshell: add mypy + ruff 2023-12-26 19:50:34 +01:00
pyproject.toml typecheck twisted 2024-01-01 15:38:28 +00:00
README.md Improve readme 2023-12-24 07:51:41 +00:00

README.md

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.
  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: