Skip to content

Commit

Permalink
Document branches.{primary,secondary,build_prs}
Browse files Browse the repository at this point in the history
Signed-off-by: magic_rb <[email protected]>
  • Loading branch information
MagicRB committed Oct 6, 2024
1 parent c0302e1 commit b2ed161
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions nix/master.nix
Original file line number Diff line number Diff line change
Expand Up @@ -496,16 +496,31 @@ in
branches = {
build_prs = lib.mkOption {
type = lib.types.bool;
description = ''
When enabled buildbot-nix will schedule builds for ever PR opened.
It will however not register GC roots.
'';
default = true;
};

primary = lib.mkOption {
type = lib.types.str;
description = ''
A `re` Python compatible regex specifying which additional branches should
buildbot-nix consider in addition to the default branch. Like for the default
branch, buildbot-nix will register GC roots for any builds it performs for this
branch. An empty regex means to not consider any additional branches.
'';
default = "";
};

secondary = lib.mkOption {
type = lib.types.str;
description = ''
Refer to the descryption of `branches.primary`, the only difference between it and this
option is that buildbot-nix will *not* register GC roots for any builds it performs,
similarly to how it behaves for PRs.
'';
default = "";
};
};
Expand Down

0 comments on commit b2ed161

Please sign in to comment.