Zum Hauptinhalt springen

Was jede Einstellung einer Regel bedeutet

Was jede Einstellung einer Regel bedeutet

Eine Regel entscheidet, welche Ereignisse eines Repositorys angekündigt werden, wo und in welcher Form. Hier steht jede Einstellung des Assistenten in der Reihenfolge, in der er nach ihr fragt, jede in einem Satz, mit einem Beispiel für einen Aufbau, der sie nutzt.

Welches Repository?

Welches Repository? Das Repository, dessen Releases, Tags oder Commits diese Regel ankündigt. Eine Regel beobachtet ein Repository; mehrere Repositories brauchen mehrere Regeln.

Wohin soll gepostet werden?

Wohin soll gepostet werden? Das Ziel: ein Slack-Workspace, ein Discord-Kanal, ein Telegram-Chat oder ein Webhook-Endpunkt, jeweils zuerst auf der Seite der Ziele verbunden.

Welcher Kanal? Der Slack-Kanal, in den gepostet wird. Discord, Telegram und ein Webhook behalten den Kanal, mit dem sie verbunden wurden. Ein privater Slack-Kanal braucht die App als Mitglied: In einen privaten Channel posten.

Welche Vorlage?

Welche Vorlage? Die Form der Nachricht: was sie zeigt, in welcher Reihenfolge und wie viel von den Release-Notes. Standard verwenden nimmt die Standardvorlage, die bis zu 1.200 Zeichen der Notes behält.

Was soll beobachtet werden?

Veröffentlichte Releases kündigt ein Release an, wenn es auf GitHub veröffentlicht wird; ein Entwurf bleibt still. Beispiel: Versionen aus main.

Gepushte Tags kündigt einen gepushten Tag etwa zehn Minuten später an, außer ein Release zu diesem Tag kommt vorher an, das dann stattdessen angekündigt wird. Beispiel: Tags ohne Releases.

Commits, die auf einen Branch gepusht werden kündigt die Commits an, die auf einem Branch landen, gesammelt in einer Nachricht, sobald der Branch 30 Minuten lang still war. Nur Slack, und nur für ein Repository, auf dem die App installiert ist. Beispiel: Commits auf einem Branch.

Mir ist klar, was gepostet wird bestätigt, dass jede Commit-Zeile auf diesem Branch für alle im Kanal lesbar wird, auch aus einem privaten Repository.

Welcher Branch ist der Branch, dessen Commits angekündigt werden.

Nur Tags, die passen auf lässt nur die Releases und Tags durch, deren Name auf eines der Muster passt; leer lässt alles durch. * steht für eine beliebige Folge von Zeichen, mehrere Muster werden durch Leerzeichen getrennt, und Groß- und Kleinschreibung zählen. Beispiel: mehrere Pakete in einem Repository, Beispiel: Staging und Produktion.

Außer Tags, die passen auf hält die Releases und Tags draußen, deren Name auf eines der Muster passt, egal was sie sonst durchlassen würde. Beispiel: Beta, Release Candidate und stabil.

Vorabversionen einschließen lässt Vorabversionen durch, ist aus, wenn eine Regel beginnt, und kennzeichnet jede in der Nachricht als Vorabversion. Pre-Releases sagt, was als Vorabversion zählt.

Letzte Releases und Tags zeigen listet, was das Repository zuletzt veröffentlicht hat, und sagt zu jedem Eintrag, ob diese Regel ihn ankündigen würde und wenn nicht, warum.

Nachricht aktualisieren, wenn die Release-Notes geändert werden hält die Nachricht im Gleichlauf mit den Notes auf GitHub; an, wenn eine Regel beginnt. Ein Webhook-Endpunkt bekommt stattdessen ein Ereignis release.updated.

Mehrere Releases kurz nacheinander zu einer Nachricht bündeln hält die Releases des Repositorys nach jedem zehn Minuten zurück und schickt eine Nachricht, die sie alle aufzählt, spätestens nach einer Stunde. Nur Slack. Beispiel: viele Releases auf einmal.

Darstellung wählt zwischen Compact, einer Nachricht je Release, und Thread, der Überschrift mit den Notes als Antwort darunter. Nur Slack.

Wenn das Release auf GitHub gelöscht wird entscheidet, was mit der Nachricht passiert, wenn ihr Release gelöscht wird: Die Nachricht so lassen, wie sie gepostet wurde, so beginnt eine Regel, Die Nachricht als zurückgezogen kennzeichnen oder Die Nachricht löschen. Mit einer der letzten beiden bekommt ein Webhook-Endpunkt ein Ereignis release.deleted.

Mehrere Ziele

Eine Regel postet an ein Ziel, also braucht dasselbe Repository in Slack und auf Discord zwei Regeln. Beispiel: ein Repository, mehrere Ziele zeigt, was sich zwischen ihnen unterscheidet.