Branch πΏΒΆ
CI Impact πΒΆ
The branch prefix MUST match the type of change. The PR workflow uses it to classify the scope and decide which CI pipeline to run.
Branch prefix |
Scope |
Matching files |
CI behavior |
|---|---|---|---|
|
Changes to agent instructions or prompts |
|
Skips orchestrator, finishes green through the lightweight scope gate. |
|
Documentation-only changes |
|
Skips orchestrator, finishes green through the lightweight scope gate. |
|
New features or enhancements |
|
Runs the full orchestrator pipeline. |
|
Bug fixes |
|
Runs the full orchestrator pipeline. |
|
Automated or maintenance updates |
|
Runs the full orchestrator pipeline. |
|
Maintenance, dependency, and tooling updates (incl. branches created by cron-update.yml) |
|
Runs the full orchestrator pipeline. |
|
Automated alert-triggered fixes |
|
Runs the full orchestrator pipeline. |
|
Automated dependency updates |
|
Runs the full orchestrator pipeline. |
Enforcement πΒΆ
The PR workflow fails its validation run when the branch prefix does not match the PR scope. The ruleset on main does not require that run to pass, see branch.md for the rules it enforces.
The naming conventions below are additionally checked locally by the lint test test_branch_name.py, which fails make test-lint when the checked-out branch uses an unknown prefix (e.g. feat/ instead of feature/) or a non-kebab-case description.
Naming Conventions π·οΈΒΆ
The description MUST use kebab-case (lowercase words separated by hyphens) and SHOULD be short enough to read at a glance.
The full branch name MUST follow one of the patterns below, depending on whether the change targets a specific role or is general:
Case |
Pattern |
Example |
|---|---|---|
General feature |
|
|
Role feature |
|
|
General fix |
|
|
Role fix |
|
|
General update |
|
|
Chore |
|
|
Alert autofix |
|
|
Documentation |
|
|
Agent |
|
|
Dependabot |
|
|
feature, update, documentation, and agent branches MUST NOT reference a ticket ID.
alert-autofix branches reference the alert ID instead of a ticket ID.
dependabot branches are created automatically and MUST NOT be renamed.