Zum Hauptinhalt springen

Beispiel: ein Repository, mehrere Ziele

Beispiel: ein Repository, mehrere Ziele

Halyard entwickelt halyard/sync-engine. Die Entwickler lesen Slack, die Community trifft sich auf Discord, eine Gruppe von Kunden folgt einem Telegram-Kanal, und eine interne Statusseite will ebenfalls von jeder Version wissen. Jedes Release soll alle vier erreichen.

So arbeitet das Team

Gewöhnliche Releases mit Notes, v5.3.0, veröffentlicht von main.

Die Regeln

Eine Regel postet an ein Ziel, also braucht es vier Regeln für dasselbe Repository, eine je Ziel. Verbinde jedes Ziel zuerst auf der Seite der Ziele; der Assistent bietet die verbundenen an.

Slack Discord Telegram Webhook
Wohin soll gepostet werden? der Workspace, dann ein Kanal unter Welcher Kanal? der Kanal des Servers, gewählt beim Verbinden der Chat, gewählt beim Verbinden der Endpunkt, gewählt beim Verbinden
Welche Vorlage? Standard verwenden, oder eine je Ziel ebenso ebenso ebenso

Die übrigen Schalter dürfen sich je Regel unterscheiden, und das ist ein Grund, vier Regeln zu behalten statt einer: Der Telegram-Kanal der Kunden will vielleicht Vorabversionen einschließen aus, während der Slack-Kanal der Entwickler ihn an hat.

Was sich je Ziel unterscheidet

Slack Discord Telegram Webhook
Die Notes in die Formatierung von Slack umgesetzt in das Markdown von Discord umgesetzt in die Formatierung von Telegram umgesetzt nicht gesendet; die Nutzdaten tragen Repository, Tag, Titel, Status als Vorabversion, Link und Zeitpunkt
Die Grenze des Ziels 3.000 Zeichen je Abschnitt 4.096 Zeichen in der Beschreibung 4.096 Zeichen je Nachricht —
Darstellung (Compact oder Thread) wählbar nicht wählbar nicht wählbar nicht wählbar
Mehrere Releases kurz nacheinander zu einer Nachricht bündeln wählbar nicht wählbar nicht wählbar nicht wählbar
Commits, die auf einen Branch gepusht werden wählbar nicht wählbar nicht wählbar nicht wählbar

Die Notes werden zweimal gekürzt, aus zwei verschiedenen Gründen. Die Vorlage legt fest, wie viel davon in eine Nachricht gehört, 1.200 Zeichen, solange sie nichts anderes sagt, und dieser Schnitt ist still: Er ist das, was die Vorlage verlangt hat. Die eigene Grenze des Ziels ist der zweite, und eine Nachricht, die dort gekürzt wurde, sagt das an ihrem Ende, mit einem Link auf die vollständigen Notes.

Wo ein Schnitt auch fällt, er lässt nie eine Formatierung halb offen: Ein Code-Block, ein fetter Titel oder ein Link, der nicht mehr passt, fällt als Ganzes weg.

Was ankommt

Dasselbe Release viermal, jedes in der Form, die sein Ziel zeichnet. Nachricht aktualisieren, wenn die Release-Notes geändert werden und Wenn das Release auf GitHub gelöscht wird wirken je Regel: Slack, Discord und Telegram ändern oder entfernen die Nachricht, die sie gepostet haben, und der Webhook-Endpunkt bekommt ein Ereignis release.updated oder release.deleted.

Eine Zustellung an einen Webhook ist signiert: Der Endpunkt kann den Header webhook-signature prüfen und alles ablehnen, was er nicht erkennt.

Was schiefgehen kann

  • Ein Ziel verliert die Verbindung, eine entfernte Slack-App oder ein gelöschter Discord-Kanal. Seine Regel hält an, sagt auf der Seite der Regeln, warum, und die anderen drei laufen weiter.
  • Ein privater Slack-Kanal bleibt leer, bis die App eingeladen ist. In einen privaten Channel posten hat den Befehl.
  • Lange Notes wirken an einem Ziel vollständig und an einem anderen gekürzt, weil die Grenzen verschieden sind. Der Link am Ende einer gekürzten Nachricht führt zu den vollständigen Notes auf GitHub.