Skip to content

docs: clarify release versioning guidance #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kevin Green (KevinGreen) wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −5
Open

docs: clarify release versioning guidance #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d384a7
docs: clarify release versioning guidance
KevinGreen Nov 5, 2026
c2ede1d
docs: classify removal of top-level inputs as breaking
KevinGreen Nov 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,19 @@ GKE deletion protection must exist on the source pool before hardware replacemen
- Do not describe PDBs as an unconditional zero-downtime guarantee.
- Test role isolation, API compatibility, and cross-cloud behavior after PDB changes.

### Version Numbers
### Release Versioning

Chart version numbers are semantically meaningful for the upgrade path:
- Minor versions (e.g., 5.2.0) are additive, non-breaking chart features
- Major versions (e.g., 6.0.0) carry Data Plane image tag changes that affect runtime behavior
Choose the chart version bump based on changes to both the chart and the Braintrust release it deploys:

Do not bump `Chart.yaml` version without explicit coordination - version numbers determine customer upgrade sequencing.
- **Major:** Increment the major version for breaking changes in either the chart or the Braintrust release.
- **Minor:** Increment the minor version for non-breaking changes in either the chart or the Braintrust release, unless the release contains only documentation changes and backward-compatible bug fixes.
- **Patch:** Increment the patch version when the release contains only documentation changes and backward-compatible bug fixes.

Removing a top-level chart input (value) is a breaking change and requires a major version bump.

Use the highest applicable version bump across all changes in the release. Reset the minor and patch versions to zero when incrementing the major version, and reset the patch version to zero when incrementing the minor version.

Do not bump the version in `braintrust/Chart.yaml` without explicit coordination; version numbers determine customer upgrade sequencing.

## Review guidelines

Expand Down
Loading