Zum Hauptinhalt springen

Beispiel: Versionen aus main

Beispiel: Versionen aus main

Larkspur Tools entwickelt larkspur/inkwell, einen Markdown-Editor. Diese Seite verfolgt den häufigsten Aufbau von der Version auf GitHub bis zur Nachricht im Kanal: fertige Versionen mit Release-Notes, angekündigt in einem Slack-Kanal.

So arbeitet das Team

Das Team merged nach main. Ist eine Version fertig, taggt jemand sie, v1.4.0, und veröffentlicht auf GitHub ein Release zu diesem Tag, mit den Notes in der Beschreibung. Vorabversionen gibt es keine, und jede veröffentlichte Version ist für alle in #inkwell-releases gedacht.

Was auf GitHub entsteht

Ein Release je Version: der Tag v1.4.0, der Titel Inkwell 1.4.0 und die Notes als Beschreibung. Für git würde der Tag allein reichen, aber erst das Release trägt die Notes, und die Notes sind es, die jemand im Kanal lesen will.

Die Regel

Neue Regel, dann Schritt für Schritt:

  1. Welches Repository? larkspur/inkwell.
  2. Wohin soll gepostet werden? Der Slack-Workspace, und unter Welcher Kanal? #inkwell-releases.
  3. Welche Vorlage? Standard verwenden, außer das Team hat eine eigene geschrieben.
  4. Was soll beobachtet werden?
    • Veröffentlichte Releases: an, so wie die Regel beginnt.
    • Gepushte Tags: aus. Jede Version hat hier ein Release, der Tag würde sie also ein zweites Mal ankündigen, und ohne Notes.
    • Nur Tags, die passen auf: v*. Jede Version dieses Repositorys beginnt mit einem v, also bleibt ein Hilfs-Tag wie docs-preview draußen, auch wenn jemand ein Release dafür veröffentlicht.
    • Außer Tags, die passen auf: leer.
    • Vorabversionen einschließen: aus. Das Team veröffentlicht keine, und wenn doch einmal, bleiben sie draußen, bis jemand anders entscheidet.
    • Nachricht aktualisieren, wenn die Release-Notes geändert werden: an, so wie die Regel beginnt. Ein Tippfehler, der nach dem Veröffentlichen in den Notes korrigiert wird, ist dann auch im Kanal korrigiert.
    • Mehrere Releases kurz nacheinander zu einer Nachricht bündeln: aus. Ein Repository veröffentlicht hier eine Version nach der anderen.
    • Darstellung: Compact. Thread passt zu einem Kanal, in den mehrere Repositories posten und in dem lange Notes sich gegenseitig aus dem Blick schieben würden.
    • Wenn das Release auf GitHub gelöscht wird: Die Nachricht als zurückgezogen kennzeichnen, damit eine zurückgezogene Version nicht weiter aktuell aussieht.

Dann Regel anlegen.

Was im Kanal ankommt

Wird v1.4.0 veröffentlicht, kommt innerhalb von Sekunden eine Nachricht: der Titel des Releases, seine Notes und ein Link auf das Release bei GitHub. Die Notes werden für Slack umgesetzt, sodass Überschriften, Listen, Links und Code so lesbar sind wie auf GitHub. Notes, die länger sind, als die Vorlage erlaubt, also 1.200 Zeichen, solange die Vorlage nichts anderes sagt, enden dort, wo die Vorlage sie schneidet, und der Link führt zum Rest.

Was schiefgehen kann

  • Ein Tag, der ohne Release gepusht wird, wird nicht angekündigt, weil diese Regel Releases beobachtet. Das ist hier gewollt; Beispiel: Tags ohne Releases zeigt den anderen Aufbau.
  • Ein Release-Entwurf bleibt still, bis er veröffentlicht wird.
  • Ein privater Kanal bleibt leer, bis die App eingeladen ist. In einen privaten Channel posten hat den einen Befehl, der das behebt.