Branch protection on main
August 10, 2026 · View on GitHub
main is gated by a declarative branch-protection policy. The source of truth is .github/branch-protection.json; the apply mechanism is scripts/apply-branch-protection.sh. Re-running the script with a changed JSON is idempotent.
This page explains what the policy says and how to change it.
Current policy
| Setting | Value | Why |
|---|---|---|
| Required status checks (strict) | Classify Changes, Check AGENTS.md Links, Test omnigraph-server --features aws, Format (rustfmt), Lint (clippy) | Code-changing PRs must pass the pinned rustfmt and Clippy gates, the AWS-feature build/test, and AGENTS.md link integrity. The format and lint jobs still report as skipped for documentation-only PRs. Test Workspace is deliberately not required: it runs only after merge to main, on tags, or by manual dispatch. A required check that never reports on PRs would leave every PR pending. The trade-off is explicit: a regression may make main briefly red, at which point unrelated merges stop until it is fixed or reverted. See ci.md. Each required context must exactly match a job name that reports on PRs. strict: true requires the branch to be up to date with main. |
| Required approving reviews | 0 | No human-review gate. With a 2-person team where both maintainers own everything, requiring an approval meant every PR needed the other person (or an admin/bypass override) — friction with no real review value. CI checks are the gate; maintainers merge their own PRs once checks pass. Raise this to 1 if an outside-contributor flow ever needs a review gate. |
| Require code-owner reviews | false | CODEOWNERS was removed entirely (see the git history of .github/); there is no code-owner review requirement. |
| Require linear history | true | No merge commits — squash or rebase only. Matches recent practice. |
| Disallow force pushes | true | No history rewrites on main. |
| Disallow branch deletions | true | main cannot be deleted. |
| Required conversation resolution | true | All review comment threads must be resolved before merge. |
| Enforce on admins | false | Admins can override the gates (enforce_admins: false in the JSON). This is the intended escape hatch for the 2-person team; tightening to true is tracked under hardening below. |
| Required signed commits | not yet | Not enabled. Would lock out maintainers until everyone enrolls GPG/SSH commit signing. Tracked as a follow-up. |
How to apply
Run from the repository root:
./scripts/apply-branch-protection.sh
The script reads .github/branch-protection.json, strips the human-readable _comment field (the GitHub API rejects unknown keys), and PUTs to repos/ModernRelay/omnigraph/branches/main/protection.
Requires gh authenticated with a token that has admin permissions on the repository.
To preview without applying:
DRY_RUN=1 ./scripts/apply-branch-protection.sh
How to change the policy
- Edit
.github/branch-protection.json. - Open a PR. The JSON change goes through normal review.
- After the PR merges, an admin runs
./scripts/apply-branch-protection.shto push the new policy to GitHub.
The script is not run automatically by CI. Branch-protection changes are admin actions that should be applied deliberately — a CI-driven automatic apply would mean any merged PR could rewrite protection rules, which defeats the purpose. The script's existence makes the apply reproducible; the admin's manual invocation is the audit point.
How to read the current GitHub state
gh api repos/ModernRelay/omnigraph/branches/main/protection
Outputs the live policy. Compare against .github/branch-protection.json to detect drift.
Why declared as code
- Audit trail:
git log .github/branch-protection.jsonshows every change with a reviewable diff and a merge commit. - Disaster recovery: if branch protection is accidentally removed or weakened via the UI, the JSON is the canonical recovery point.
- Consistency: repository policy lives in the repository, reviewed like code.
What this gates
After branch protection is applied, every PR targeting main must:
- Pass all listed status checks.
- Be up-to-date with
main(rebase or merge-from-main). - Have all review conversations resolved.
- Be squash- or rebase-merged (no merge commits).
No human approval is required (required_approving_review_count: 0). Repository
admins can override the gates (enforce_admins: false).
Subsequent hardening (not in this PR)
The branch-protection policy is the foundation. Future hardening adds:
- Required signed commits (
required_signatures: true) — once maintainers enroll GPG/SSH signing. - Tag protection for
v*tags viarepos/.../tags/protection. - Required reviewers from specific teams for high-leverage paths (e.g.,
docs/dev/invariants.md) via a GitHub ruleset's path-scoped required-review rule, if a review gate is ever reintroduced. - More required CI checks:
cargo deny,cargo audit, CodeQL, secret scanning, schema-lint (MR-946).
See the hardening playbook for the full plan.