Jeden z nástrojů na této stránce děláme my. Snažili jsme se ostatní popsat podle toho, k čemu jsou stavěné, spíš než podle toho, kde nedostačují, a sekce o našem vlastním produktu jasně říká, kdo by ho neměl používat.
Tři kategorie
Hostovaný widget a stránka
Píšeš záznamy v jejich editoru, hostují stránku a dají ti widget v aplikaci. Nejrychlejší na spuštění, a záznamy žijí na jejich infrastruktuře, ne tvé. Beamer a AnnounceKit jsou nejjasnější příklady.
Balíček zpětné vazby s připojeným changelogem
Changelog je jeden modul vedle hlasování o funkcích, veřejné roadmapy a schránky zpětné vazby. Stojí za to, pokud chceš celý cyklus od jednoho dodavatele, přehnané, pokud chceš jen publikovat poznámky k vydání. Canny, Frill a Featurebase jsou tady.
Generováno z tvého repozitáře
Changelog je produkován z commitů, pull requestů nebo issues místo psaní ručně. Pohybuje se od souboru sestaveného v CI až po sepsaný, zrecenzovaný, publikovaný záznam. git-cliff a github-changelog-generator jsou na souborovém konci; LaunchNotes, Released a náš vlastní produkt jsou na publikovaném konci.
Ve zkratce
| Nástroj | Typ | Nejlepší pro |
|---|---|---|
| Beamer | Hostovaný widget | Panel s novinkami v aplikaci spuštěný ještě dnes odpoledne, bez času vývojářů. |
| AnnounceKit | Hostovaný widget | Totéž, s větším důrazem na to, kdo vidí které oznámení. |
| Canny | Balíček zpětné vazby | Týmy, které chtějí hlasování o funkcích a veřejnou roadmapu, s changelogem jako závěrečným krokem této smyčky. |
| Frill | Balíček zpětné vazby | Menší týmy, které chtějí totéž co Canny, jen v lehčí podobě. |
| LaunchNotes | Generováno z repozitáře | Větší organizace, které koordinují oznámení napříč týmy, často s Jirou jako základem. |
| Released | Generováno z repozitáře | Týmy, které žijí v Jiře a chtějí changelog vytvářený z issues, aniž by ji opustily. |
| git-cliff | Generátor souboru | Open-source projekty, které chtějí CHANGELOG.md sestavený v CI z conventional commits, bez čehokoliv hostovaného. |
| Changeloop | Generováno z repozitáře | Týmy, které chtějí záznam sepsaný ze sloučených pull requestů a pak vykreslený vlastním frontendem z JSON feedu. |
Jak vybrat
- Začni s tím, kde se changelog musí objevit. Pokud musí vypadat jako součást tvého produktu, hostovaná stránka, na kterou odkazuješ, zklame bez ohledu na to, jak dobrý je její editor, a chceš buď widget, který můžeš přestylizovat, nebo feed, který vykresluješ. Pokud odkazovaná stránka stačí, hostované nástroje vyžadují mnohem méně práce.
- Pak se zeptej, kdo píše záznamy. Pokud je odpověď „inženýr, který to sloučil“, vyber něco, co čte tvůj repozitář, protože cokoliv jiného přidává ruční krok přesně ve chvíli, kdy jsou všichni zaneprázdnění. Pokud je odpovědí produktový marketér pracující podle plánu vydání, editor se hodí lépe a automatizace repozitáře jen bude překážet.
- Pak se zeptej, jestli potřebuješ zbytek cyklu. Hlasování o funkcích a veřejná roadmapa jsou skutečně užitečné a skutečně větší závazek. Koupě balíčku kvůli jeho modulu changelogu je způsob, jak týmy skončí platit za čtyři věci, aby použily jednu.
- Nakonec zkontroluj, co se stane s tvými záznamy, pokud odejdeš. Nástroj, který je exportuje jako strukturovaná data, se výrazně liší od toho, kde žijí na hostované stránce, kterou bys musel scrapovat.
Kde se hodí náš vlastní nástroj, a kde ne
Changeloop čte každý sloučený pull request, sepíše záznam orientovaný na uživatele, odfiltruje aktualizace závislostí a refaktoringy a podrží návrh pro recenzi. To, co je publikováno, jde do veřejného JSON feedu s feedem roadmapy vedle, plus dvouřádkový widget a hostovaná stránka jako záložní řešení. Feed je to podstatné: zamýšlené nastavení je vykreslovat svůj changelog uvnitř vlastního produktu s vlastními komponentami.
Nevybírej, pokud:
- Tvá vydání nevycházejí z tvých repozitářů. Návrhy sepisuje ze sloučení, nebo v režimu push z pushů, takže tým dodávající mimo pracovní postup v Gitu nemá nic k recenzi.
- Chceš hlasování o funkcích a roadmapu, o které hlasují tvoji uživatelé. Feed roadmapy existuje, ale je řízen označenými issues, ne hlasováním uživatelů. Balíček zpětné vazby je pro to správná kategorie.
- Chceš vypilovaný editor a hostovanou stránku jako hlavní produkt. Hostovaná stránka existuje jako záložní řešení, a nástroje postavené kolem té svojí to udělají lépe.
- Jsi samostatný open-source projekt, který chce jen CHANGELOG.md v repozitáři. Použij git-cliff, který je zdarma a udělaný přesně pro to.
Časté otázky
Potřebujeme vlastně nástroj?
Chvíli ne. Soubor markdown, nebo stránka na tvém vlastním webu, je docela dobrý changelog a nestojí nic. Bod, kdy se nástroj začne vyplácet, je, když se psaní záznamů stane krokem, který se přeskakuje, nebo když chceš stejné záznamy na třech místech bez udržování tří kopií.
Můžeme se od jednoho z nich později přesunout?
Zcela záleží na tom, jestli záznamy vycházejí zpět jako strukturovaná data. Zeptej se před začátkem, ne po: toto je jediná otázka v seznamu, jejíž chybné zodpovězení je nákladné, protože changelog je rostoucí archiv a přepsat dva roky jeho obsahu není projekt, který kdokoliv schválí.
A co psaní pomocí AI asistenta?
Většina z nich teď sepisuje s nějakým modelem někde. Záleží mnohem méně na tom, než co model dostane. Nástroj, který vidí jen předmět commitu, může jen přepsat ten předmět; ten, co vidí název a popis pull requestu, má dost na to, aby popsal změnu v termínech toho, co dělá pro uživatele. Ptej se, jaký je vstup, ne jestli je tam AI.
Další čtení: automatizace changelogu a její limity, o tom, který ze čtyř kroků by měl být automatický.
Ten, co dává feed na první místo
Sepsaný z tvých sloučených pull requestů, podržený pro recenzi, publikovaný do JSON feedu, který si sám vykresluješ. Zdarma pro jeden repozitář, bez karty.
Začít zdarma