Example: beta, release candidate and stable
Example: beta, release candidate and stable
Fennel Labs publishes fennel/sdk, a library other teams build on. A new major version goes through
betas and release candidates before it is final, and a CI job publishes a build every night. The
people who use the library want to hear about finished versions; the people who test it want the
betas and release candidates as well, and nobody wants the nightly builds in a channel.
How the team works
- Betas and release candidates are published as releases with the pre-release box ticked:
v2.0.0-beta.1,v2.0.0-beta.2,v2.0.0-rc.1. - The finished version is an ordinary release:
v2.0.0. - A nightly build is published as a pre-release too:
v2.1.0-nightly.20261030.
What appears on GitHub
Releases of three kinds in one repository. chronik reads a release's pre-release state from the box on GitHub, whatever the version is called, so all betas, release candidates and nightly builds are pre-releases here. A tag without a release has no such box, and there its name decides: Pre-releases lists the markers that count.
A channel for finished versions
A rule for #sdk-releases:
- Published releases: on.
- Only tags matching:
v*. - Include pre-releases: off. This is all it takes: every beta, release candidate and nightly build is a pre-release and stays out.
A channel for the testers
A second rule for the same repository, posting into #sdk-testing:
- Published releases: on.
- Only tags matching:
*-beta* *-rc*. Only betas and release candidates match, so a finished version does not reach the testers twice and a nightly build does not reach them at all. - Include pre-releases: on. Betas and release candidates are pre-releases, so without it they stay out, and the wizard says so under the pattern while you type.
Every message in this channel is marked as a pre-release, so nobody mistakes a release candidate for the finished version.
One channel for everything but the nightly builds
If finished versions and test versions should share a channel, one rule is enough:
Include pre-releases on, Only tags matching empty, and Except tags matching
*-nightly*. A tag that matches an exclusion stays out, whatever else matches it.
When a release candidate becomes the release
Most teams publish the finished version under its own tag, v2.0.0, and it is announced like any
other. A team that instead un-ticks the pre-release box of the last candidate gets an edit rather
than a new release from GitHub: a rule that announced the candidate updates its message, and the
pre-release marking disappears from it. A rule that had pre-releases off announces the release at
that moment, as a new message.
What can go wrong
- A pre-release published without the box ticked is a finished version for chronik and reaches
#sdk-releases. If the release is deleted on GitHub decides what happens to that message when it is pulled. - A nightly build that is only a tag, with no release, reaches none of these rules, because none of them watches Pushed tags.