Skip to content

Repository rules

A repository adds very little. The enterprise and organization rulesets already require a pull request, the lint and build checks and the release checks on its default branch. A repository ruleset holds only what is specific to that repository, and it never repeats a rule from above.

This page uses bundu-labs/bundu-docs as the example, as read from the API.

  • Target: the default branch, main.
  • Mode: active.
  • Rule: a merge queue with these settings:
Setting Value
Merge method MERGE, which creates a merge commit
Grouping strategy ALLGREEN: a group merges only if every entry in it is green
Entries built at once up to 5
Entries merged at once at least 1, at most 5
Wait before merging a group 0 minutes
Time allowed for a check to respond 60 minutes
  • Bypass: no bypass actors are listed on this ruleset.

Why a queue. A pull request can pass its checks against an older main and then break main when it lands. The queue re-runs the required checks against the group it is about to merge, so main only receives merges that were tested against the state they land on.

Why the MERGE method. The queue creates a merge commit, so the commits on a branch are kept on main as they were written. The written standard gives the reason for MERGE on main as a companion to a staging branch, where squash merges used to diverge. This repository has no staging branch, so that reason does not apply here. The method is what the ruleset currently sets.

Setting Value Notes
Default branch main
Visibility internal
Allow merge commits on
Allow squash merging on
Allow rebase merging on
Delete head branches on merge on Branches are removed after they merge.
Archived no
  • No repository-level required checks. Every required check comes from the organization ruleset, which applies here.
  • No review or merge-method rules. A narrower repository list would silently override the organization’s list, so none is set.
  • No classic branch protection. Rulesets are the only protection on the default branch.

bundu-docs has one workflow file of its own, staging-version.yml. It runs on a push to a staging branch, and this repository has no staging branch, so it does not run. It is left in place for now; removing it is a separate change.

Everything else that gates a change is a required workflow from the central repositories. The release is produced by the enterprise-wide auto release job, not by a workflow in this repository. See how a change gets released.