Skip to content
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

Jump to bottom

branching policy #577

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

branching policy #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions docs/src/v1-api/branches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Branches

## `main` - this is where development happens; it can **break**!

As we strive for trunk-based development and smaller commits, testing each
subsystem on each supported system for each commit is expensive in terms of
computing resources, so we only run CI checks on `x86_64-linux` here.

Another reason is that, as of time of writing, you need shell access
to a target, i.e. `aarch64-darwin` machine, to update platform-specific lock
files. We hope to allow at least remote builders here soon.

## `stable` - still no warranties, but some best-effort promises ;)

Each commit here should include a changelog since the last commit, and pass all CI jobs
on all platforms, before being tagged. Tagging it will then publish a GitHub release.

A staging branch may be used to prepare the changelog and fixes for non `x86_64-linux`
when needed, but it should be merged into `main` before tagging and cherry-picking
that commit into `stable`.

The changelog contains a list of breaking changes since the last release.