How a new TigerBeetle release is made. Note that the process is being established, so this document might not perfectly reflect reality just yet.
What Is a Release?
TigerBeetle is distributed in binary form. There are two main reasons for this:
- to ensure correctness and rule out large classes of configuration errors, the actual machine code must be tested.
- Zig is not stable yet. Binary releases insulate the users from this instability and keep the language as an implementation detail.
TigerBeetle binary is released in lockstep with client libraries. At the moment, implementation of the client libraries is tightly integrated and shares code with TigerBeetle, requiring matching versions.
Canonical form of the "release" is a
dist/ folder with the following artifacts:
tigerbeetlebinaries built for all supported architectures.
dotnet/subdirectory with a Nuget package.
go/subdirectory with the source code of the go client and precompiled native libraries for all supported platforms.
java/subdirectory with a
node/subdirectory with a
.tgzpackage for npm.
Release artifacts are uploaded to appropriate package registries. GitHub release is used for synchronization:
- a draft release is created at the start of the publishing process,
- artifacts are uploaded to GitHub releases, npm, Maven Central, and Nuget. For Go, a new commit is pushed to https://github.com/tigerbeetle/tigerbeetle-go
- if publishing to all registries were successfully, the release is marked as non-draft.
All publishing keys are stored as GitHub Actions in the
Because releases are frequent, we avoid specifying the version in the source code. Instead, the version is setup automatically by the release process itself, using sequential build numbers as the patch version. It might the case that a particular version is skipped (e.g., if a release partially failed). It is also a possibility that two releases are functionally identical (this means that no pull requests were merged in a week).
Releases are triggered manually, on Monday. Default release rotation is on the devhub: https://tigerbeetle.github.io/tigerbeetle/.
The middle name is the default release manager for the current week. After the release, please ping the next person to pass the baton.
Before triggering a release, update CHANGELOG.md with the changes since the last release. Run the following command to create a release branch and generate changelog skeleton:
$ ./zig/zig build scripts -- changelog
After the changelog PR is merged, trigger a release by pushing a commit from
$ git fetch origin && git push origin origin/main:release
This triggers the
release.yml workflow. The workflow doesn't run unit-tests,
not rocket science rule is assumed. The workflow
requires an approval of at least one other person.
If the release manager isn't available on Monday, a volunteer picks up that release. Releases can be skipped if there are not enough people to make a release (at least two are required) or if there aren't any changes in a given week.
Purposes of the changelog:
- For everyone: give project a visible "pulse".
- For TigerBeetle developers: tell fine grained project evolution story, form shared context, provide material for the monthly newsletter.
- For TigerBeetle users: inform about all visible and potentially relevant changes.
- Consider skipping over trivial changes in the changelog.
- Don't skip over meaningful changes of the internals, even if they are not externally visible.
- If there is a story behind a series of pull requests, tell it.
- And don't forget the TigerTrack of the week!