What each setting of a rule means
What each setting of a rule means
A rule decides which events of one repository are announced, where, and in what shape. Here is every setting of the wizard in the order it asks for them, each in a sentence, with an example of an arrangement that uses it.
Which repository?
Which repository? The repository whose releases, tags or commits this rule announces. A rule watches one repository; several repositories need several rules.
Where should it post?
Where should it post? The destination: a Slack workspace, a Discord channel, a Telegram chat or a webhook endpoint, each connected on the destinations page first.
Which channel? The Slack channel to post into. Discord, Telegram and a webhook keep the channel they were connected with. A private Slack channel needs the app invited into it: Posting into a private channel.
Which template?
Which template? The shape of the message: what it shows, in which order, and how much of the release notes. Use the default takes the default template, which keeps up to 1,200 characters of the notes.
What should it watch?
Published releases announces a release when it is published on GitHub; a draft stays silent. Example: versions released from main.
Pushed tags announces a pushed tag about ten minutes later, unless a release for that tag arrives first, which is then announced instead. Example: tags without releases.
Commits pushed to a branch announces the commits that land on one branch, collected into one message once the branch has been quiet for 30 minutes. Slack only, and only for a repository the app is installed on. Example: commits on a branch.
I understand what will be posted confirms that every commit subject on that branch becomes readable to everyone in the channel, from a private repository too.
Which branch is the branch whose commits are announced.
Only tags matching lets through only the releases and tags whose name matches one of the
patterns; empty lets everything through. * stands for any run of characters, several patterns are
separated by spaces, and matching is case-sensitive.
Example: several packages in one repository,
Example: staging and production.
Except tags matching keeps out the releases and tags whose name matches one of the patterns, whatever else lets them through. Example: beta, release candidate and stable.
Include pre-releases lets pre-releases through, off as a rule starts, and marks each one as a pre-release in the message. Pre-releases says what counts as one.
Show the latest releases and tags lists what the repository published last and says, for each one, whether this rule would announce it, and if not, why.
Update the message when the release notes are edited keeps the message in step with the notes
on GitHub; on as a rule starts. A webhook endpoint receives a release.updated event instead.
Collect a burst of releases into one message holds the releases of the repository for ten minutes after each one and sends one message listing them all, after an hour at the latest. Slack only. Example: many releases at once.
How it appears chooses between Compact, one message per release, and Thread, the headline with the notes as a reply under it. Slack only.
If the release is deleted on GitHub decides what happens to the message when its release is
deleted: Leave the message as it was posted, which is where a rule starts, Mark the message as
withdrawn, or Delete the message. With either of the last two, a webhook endpoint receives a
release.deleted event.
Several destinations
A rule posts to one destination, so the same repository in Slack and on Discord takes two rules. Example: one repository, several destinations shows what differs between them.