Zum Hauptinhalt springen

Beispiel: Tags ohne Releases

Beispiel: Tags ohne Releases

Mossgrove pflegt mossgrove/schema-tools, ein Kommandozeilenwerkzeug. Releases auf GitHub veröffentlicht dort niemand: Ein CI-Lauf baut das Werkzeug, taggt den Commit, v0.9.3, und lädt den Build woanders hoch. Das Team will trotzdem eine Zeile in #schema-tools, wenn es eine neue Version gibt.

So arbeitet das Team

Der CI-Lauf pusht den Tag. Release-Notes auf GitHub schreibt niemand, also gibt es dort nichts zu veröffentlichen, und die Version existiert nur als Tag.

Was auf GitHub entsteht

Ein Tag, sonst nichts. Ein Tag hat einen Namen und einen Commit. Er hat keinen Titel, keine Notes und keinen Haken für eine Vorabversion, und das entscheidet, was eine Nachricht über ihn sagen kann.

Die Regel

  1. Welches Repository? mossgrove/schema-tools.
  2. Wohin soll gepostet werden? Der Slack-Workspace und #schema-tools.
  3. Welche Vorlage? Standard verwenden.
  4. Was soll beobachtet werden?
    • Gepushte Tags: an. Für ein Repository, das Tags und keine Releases hat, schaltet der Assistent ihn selbst ein und sagt, warum.
    • Veröffentlichte Releases: darf an bleiben. Solange niemand ein Release veröffentlicht, greift der Schalter nie, und an dem Tag, an dem jemand es tut, ist die Regel bereit.
    • Nur Tags, die passen auf: v*, damit ein Tag, den der CI-Lauf aus anderen Gründen setzt, etwa build-1842, draußen bleibt.
    • Vorabversionen einschließen: aus. Ein Tag ist eine Vorabversion, wenn direkt auf seine Versionsnummer eine Markierung folgt, v1.0.0-beta.2 zum Beispiel; Pre-Releases zählt sie auf.

Was im Kanal ankommt

Etwa zehn Minuten nach dem Push des Tags kommt eine Zeile: Das Repository wurde mit v0.9.3 getaggt, mit einem Link auf den Tag bei GitHub. Keine Notes, weil ein Tag keine hat.

Das Warten ist Absicht. Veröffentlicht jemand in diesen Minuten ein Release zum selben Tag, wird stattdessen das Release angekündigt, mit seinen Notes, und die Zeile über den Tag entfällt, sodass die Version einmal angekündigt wird.

Umstellen auf Releases

Wenn das Team anfängt, Notes zu schreiben, veröffentlicht es ein Release zum Tag, von Hand oder aus dem CI-Lauf. An der Regel muss sich nichts ändern: Veröffentlichte Releases kündigt es an, und das Release ersetzt die Zeile über den Tag wie oben beschrieben. Hat jede Version ein Release, kann Gepushte Tags aus.

Was schiefgehen kann

  • Mehr als drei Tags in einem Push werden für keinen davon gemeldet. Das ist eine Regel von GitHub, nicht von Chronik.io: GitHub erzeugt für einen solchen Push kein Ereignis, also gibt es nichts zu empfangen und später nichts zu reparieren. Ein CI-Lauf, der mehrere Tags auf einmal setzt, pusht sie zu dritt oder einzeln. Tags, und ein Fall, den GitHub nicht meldet erklärt es ausführlich.
  • Ein Tag, der gelöscht und unter demselben Namen neu gepusht wird, ist für GitHub ein neuer Tag und wird erneut angekündigt.