Skip to content

Guppy News laufen jetzt über die Docs und Slack ​

digital.manufaktur
  • ankündigung
  • slack

Bisher lebten Guppy-Neuigkeiten im Chat. Wer im Urlaub war oder erst später dazukam, hat sie schlicht nicht mehr gefunden. Seit dieser Woche gibt es beides: eine feste Adresse in der Doku und eine automatische Meldung in #guppy.

Wenn du das hier in Slack gelesen hast: diese Meldung hat der Bot selbst verschickt, niemand hat sie getippt.

Was sich ändert ​

Nichts an deinem Arbeitsablauf. Du pflegst weiterhin die CHANGELOG.md in deinem Repository und taggst dein Release wie immer. Den Rest übernimmt die Doku:

  1. npm run changelog:sync holt die Changelogs aus allen Guppy-Repositories.
  2. Der Stand landet als Commit in guppy-docs.
  3. Sobald der Commit auf main liegt, meldet ein CI-Job das Neue in #guppy.

Alles aus einem Push wird zu einer einzigen Nachricht zusammengefasst, nicht zu einer pro Release.

Was gemeldet wird ​

ÄnderungMeldung
Neuer Beitrag unter Newsja
Release mit neuer Minor- oder Major-Nummerja
Release mit Breaking changesja, unabhängig von der Versionsnummer
Zurückgezogenes Releaseja
Reines Patch-Releasenein, wird in einer Zeile mitgezählt

Patch-Releases bleiben absichtlich still. Sonst wird der Kanal so voll, dass die wichtigen Meldungen untergehen.

Was du davon hast ​

Wenn du etwas Wichtiges ausrollst, schreib es unter Breaking changes in die CHANGELOG.md, auch wenn du nur die Patch-Stelle erhöhst. Genau diese Überschrift sorgt dafür, dass die Meldung rausgeht statt still mitgezählt zu werden.

Wenn du etwas erklären willst, das über eine Changelog-Zeile hinausgeht, schreib einen News-Beitrag. Eine Datei in docs/news/ genügt, den Rest macht die Automatik.

Wo alles liegt ​

  • Changelog: alle Releases pro Produkt, auf Englisch, weil die Einträge in den Repositories auf Englisch geschrieben sind
  • Roadmap: woran gerade gearbeitet wird und was als Nächstes kommt
  • News: längere Beiträge wie dieser hier

Die Details zum Format stehen in CHANGELOG-CONVENTION.md im Doku-Repository.