Facem unul dintre instrumentele de pe această pagină. Am încercat să le descriem pe celelalte după ce sunt construite să facă mai degrabă decât după unde sunt insuficiente, iar secțiunea despre propriul nostru produs spune clar cine nu ar trebui să-l folosească.
Cele trei categorii
Widget și pagină găzduite
Scrii intrări în editorul lor, ei găzduiesc pagina și îți dau un widget în aplicație. Cel mai rapid de lansat, iar intrările trăiesc pe infrastructura lor, nu a ta. Beamer și AnnounceKit sunt cele mai clare exemple.
Pachet de feedback cu changelog atașat
Changelog-ul este un modul alături de votarea funcțiilor, un roadmap public și o casetă de feedback. Merită dacă vrei tot ciclul de la un singur furnizor, exagerat dacă vrei doar să publici note de lansare. Canny, Frill și Featurebase sunt aici.
Generat din repozitoriul tău
Changelog-ul este produs din commit-uri, pull request-uri sau issue-uri în loc să fie scris manual. Variază de la un fișier construit în CI până la o intrare redactată, revizuită, publicată. git-cliff și github-changelog-generator sunt la capătul de fișier; LaunchNotes, Released și propriul nostru produs sunt la capătul publicat.
Pe scurt
| Instrument | Tip | Cel mai bun pentru |
|---|---|---|
| Beamer | Widget găzduit | Un panou de noutăți în aplicație, live chiar în după-amiaza asta, fără timp de dezvoltare. |
| AnnounceKit | Widget găzduit | La fel, cu mai multă atenție la cine vede fiecare anunț. |
| Canny | Pachet de feedback | Echipe care vor votare a funcțiilor și un roadmap public, cu changelog-ul ca pas final al acelei bucle. |
| Frill | Pachet de feedback | Echipe mai mici care vor aceeași formă ca Canny, într-o variantă mai ușoară. |
| LaunchNotes | Generat din repozitoriu | Organizații mai mari care coordonează anunțurile între echipe, adesea ancorate în Jira. |
| Released | Generat din repozitoriu | Echipe care trăiesc în Jira și vor changelog-ul produs din issue-uri fără să iasă de acolo. |
| git-cliff | Generator de fișier | Proiecte open-source care vor un CHANGELOG.md construit în CI din conventional commits, fără nimic găzduit. |
| Changeloop | Generat din repozitoriu | Echipe care vor intrarea redactată din pull request-uri îmbinate și apoi randată de propriul lor front-end dintr-un feed JSON. |
Cum să alegi
- Începe cu unde trebuie să apară changelog-ul. Dacă trebuie să arate ca parte din produsul tău, o pagină găzduită la care faci link te va dezamăgi indiferent cât de bun este editorul ei, și vrei fie un widget pe care îl poți restiliza, fie un feed pe care îl randezi. Dacă o pagină cu link e în regulă, instrumentele găzduite necesită mult mai puțină muncă.
- Apoi întreabă cine scrie intrările. Dacă răspunsul este „inginerul care a îmbinat”, alege ceva care îți citește repozitoriul, pentru că orice altceva adaugă un pas manual exact în momentul în care toată lumea e ocupată. Dacă răspunsul este un marketer de produs care lucrează dintr-un plan de lansare, un editor se potrivește mai bine, iar automatizarea repozitoriului doar va încurca.
- Apoi întreabă dacă ai nevoie de restul ciclului. Votarea funcțiilor și un roadmap public sunt cu adevărat utile și cu adevărat un angajament mai mare. Cumpărarea unui pachet pentru modulul lui de changelog este cum ajung echipele să plătească pentru patru lucruri ca să folosească unul.
- În final, verifică ce se întâmplă cu intrările tale dacă pleci. Un instrument care le va exporta ca date structurate este semnificativ diferit de unul unde trăiesc pe o pagină găzduită pe care ar trebui s-o extragi manual.
Unde se potrivește propriul nostru instrument, și unde nu
Changeloop citește fiecare pull request îmbinat, redactează o intrare orientată către utilizator, filtrează actualizările de dependențe și refactorizările, și păstrează ciorna pentru recenzie. Ce este publicat merge la un feed JSON public cu un feed de roadmap alături, plus un widget de două linii și o pagină găzduită ca rezerve. Feedul este esența: configurația intenționată este să-ți randezi changelog-ul în interiorul propriului tău produs cu propriile tale componente.
Nu-l alege dacă:
- Lansările tale nu provin din repozitoriile tale. Redactează din îmbinări sau, în modul push, din push-uri, deci o echipă care livrează în afara unui flux de lucru Git nu are nimic de revizuit.
- Vrei votare a funcțiilor și un roadmap pe care votează utilizatorii tăi. Există un feed de roadmap, dar este condus de issue-uri etichetate, nu de votarea utilizatorilor. Un pachet de feedback este categoria potrivită pentru asta.
- Vrei un editor rafinat și o pagină găzduită ca produs principal. Pagina găzduită există ca rezervă, iar instrumentele construite în jurul propriei lor pagini vor face asta mai bine.
- Ești un proiect open-source solo care vrea doar un CHANGELOG.md în repozitoriu. Folosește git-cliff, care este gratuit și făcut exact pentru asta.
Întrebări frecvente
Avem nevoie de un instrument, oare?
Pentru o vreme, nu. Un fișier markdown, sau o pagină pe propriul tău site, este un changelog perfect bun și nu costă nimic. Punctul în care un instrument începe să merite este când scrierea intrărilor devine pasul care este sărit, sau când vrei aceleași intrări în trei locuri fără să întreții trei copii.
Ne putem muta de la unul dintre ele mai târziu?
Depinde în totalitate dacă intrările ies înapoi ca date structurate. Întreabă înainte de a începe, nu după: aceasta este singura întrebare din listă care e costisitor de greșit, pentru că un changelog este o arhivă în creștere, iar retastarea a doi ani din el nu este un proiect pe care cineva îl aprobă.
Dar scrierea lor cu un asistent AI?
Majoritatea acestora acum redactează cu un model undeva. Contează mai puțin decât ce primește modelul. Un instrument care vede doar un subiect de commit poate doar să rescrie acel subiect; unul care vede titlul și descrierea pull request-ului are suficient pentru a descrie modificarea în termenii a ce face pentru un utilizator. Întreabă care este intrarea, nu dacă există AI.
Lectură suplimentară: automatizarea changelog-ului, și limitele ei, despre care dintre cei patru pași ar trebui să fie automat.
Cel bazat pe feed
Redactat din pull request-urile tale îmbinate, păstrat pentru recenzie, publicat la un feed JSON pe care îl randezi singur. Gratuit pentru un repozitoriu, fără card.
Începe gratuit