Skip to main content

Example: versions released from main

Example: versions released from main

Larkspur Tools builds larkspur/inkwell, a Markdown editor. This page follows the most common arrangement from the version on GitHub to the message in the channel: finished versions with release notes, announced in one Slack channel.

How the team works

The team merges into main. When a version is ready, somebody tags it, v1.4.0, and publishes a release on GitHub for that tag, with the notes written in its description. There are no pre-releases, and every published version is meant for everybody in #inkwell-releases.

What appears on GitHub

One release per version: the tag v1.4.0, the title Inkwell 1.4.0, and the notes as its description. The tag alone would be enough for git, but the release is what carries the notes, and the notes are what a reader of the channel wants.

The rule

New rule, then one step after the other:

  1. Which repository? larkspur/inkwell.
  2. Where should it post? The Slack workspace, and #inkwell-releases under Which channel?
  3. Which template? Use the default, unless the team has written one of its own.
  4. What should it watch?
    • Published releases: on, as it starts.
    • Pushed tags: off. Every version here has a release, so the tag would announce it a second time, and without notes.
    • Only tags matching: v*. Every version of this repository starts with a v, so a helper tag like docs-preview stays out of the channel even if somebody publishes a release for it.
    • Except tags matching: empty.
    • Include pre-releases: off. The team publishes none, and if it ever does, they stay out until somebody decides otherwise.
    • Update the message when the release notes are edited: on, as it starts. A typo fixed in the notes after publishing is fixed in the channel too.
    • Collect a burst of releases into one message: off. One repository releases one version at a time.
    • How it appears: Compact. Thread suits a channel that several repositories post into, where long notes would push each other out of view.
    • If the release is deleted on GitHub: Mark the message as withdrawn, so a version that was pulled does not keep looking current.

Then Create the rule.

What arrives in the channel

When v1.4.0 is published, one message arrives within seconds: the title of the release, its notes and a link to the release on GitHub. The notes are converted for Slack, so headings, lists, links and code read as they do on GitHub. Notes longer than the template allows, 1,200 characters unless the template says otherwise, end where the template cuts them, and the link leads to the rest.

What can go wrong

  • A tag pushed without a release is not announced, because this rule watches releases. That is intended here; Example: tags without releases shows the other arrangement.
  • A draft release stays silent until it is published.
  • A private channel stays empty until the app is invited into it. Posting into a private channel has the one command that fixes it.