Example: many releases at once
Example: many releases at once
Pinecrest keeps the packages of its design system in one repository, pinecrest/components. A
release tool publishes them together: when a change touches the shared tokens, twelve packages get
a new version within two minutes, each with a release of its own. Twelve messages in a row would
bury everything else in #design-system.
How the team works
The release tool runs on main, bumps every package the change touched, and publishes one release
per package: [email protected], [email protected], [email protected] and so on, all within a few minutes.
What appears on GitHub
Twelve releases of one repository, close together. Each one is announced on its own unless the rule collects them.
The rule
- Which repository?
pinecrest/components. - Where should it post? The Slack workspace and
#design-system. Collecting is offered for Slack only. - Which template? Use the default.
- What should it watch?
- Published releases: on.
- Collect a burst of releases into one message: on.
What arrives in the channel
The first release opens a window of ten minutes, and every release that follows within it moves the end back by another ten. When ten minutes pass without a new release, one message goes out and lists every release of the burst, each with its own link. A burst that never pauses gets its message after an hour at the latest, and the next release opens a new window.
The list names fifteen releases at most and then says how many it left out, so a longer burst never reads as complete when it is not.
What collecting does not do
- It collects the releases of one rule, and a rule watches one repository. Twenty repositories released together still bring twenty messages, one per rule. Collecting is for a repository that publishes several releases at once, like this one.
- A collected message is a snapshot. A later edit to the notes of one of its releases is not applied to it, and a release of the burst that is deleted on GitHub stays in the list.
- It delays every release, not only the ones in a burst: a single release also waits ten minutes for company. A repository that rarely releases more than one version at a time is better off without it.
What can go wrong
- Nothing arrives for ten minutes after the first release, and that is the window waiting. The delivery log shows the releases as on their way meanwhile.
- More than three tags in one push are reported for none of them, a limit of GitHub. A release tool that publishes releases is not affected, because a release is its own event; one that only pushes tags runs into it. Tags, and one case GitHub does not report has the details.