Generátor changelogu

Zatím nic. Vlož výše pár řádků a stiskni Vygenerovat.

Co dělá s každým řádkem

Pravidla jsou záměrně jednoduchá a viditelná, abys mohl výsledek předpovědět místo hádání:

1. Conventional commity se seskupují podle typu. `feat` se stane Nové, `fix` se stane Opraveno, `perf` se stane Vylepšeno. `!` před dvojtečkou, nebo značka BREAKING CHANGE, přesune řádek do Zásadní změny bez ohledu na jeho typ.
2. Cokoliv, co není conventional commit, se řadí podle prvního slova. Add, Added, Introduce a Support se stanou Nové; Fix, Fixed a Resolve se stanou Opraveno; Improve, Update, Speed a Optimise se stanou Vylepšeno; Remove, Removed, Drop a Deprecate se stanou Odstraněno. Vše ostatní skončí v Ostatní, abys to seřadil ručně.
3. Šum je odstraněn: koncové číslo pull requestu, řádek `Merge pull request ...`, rozsah v závorkách a samotný prefix typu conventional commit. Zbylá věta začíná velkým písmenem.
4. Se zapnutým filtrem jsou řádky `chore`, `ci`, `test`, `build`, `style` a `refactor` zahozeny spolu s čímkoliv, co vypadá jako aktualizace závislosti. To je jediný největší rozdíl mezi changelogem, který lidé čtou, a tím, který přestanou číst.

Co nedokáže

Přepisuje tvar tvých zpráv commitů, ne jejich obsah. Pokud commit říká `fix: race in MembershipCache.resolve()`, tak to je to, co vyjde, a stále je to věta o tvém kódu místo o zkušenosti uživatele. Proměnit „race in MembershipCache“ na „pozvaní členové už nevidí prázdný přehled“ vyžaduje vědět, co změna udělala, což je část, kterou generátor nemůže odvodit z řádku předmětu commitu.

Takže výsledek ber jako první průchod: správná struktura, správné seskupení, interní šum už pryč, formulace stále na tobě k opravě.

Časté otázky

Nahrává se něco z toho, co vložím, někam?

Ne. Generátor je skript na této stránce; text nikdy neopustí tvůj prohlížeč a k nám nejde žádný požadavek, když stiskneš Vygenerovat. Můžeš to potvrdit s otevřenou kartou sítě.

Musím používat conventional commits?

Ne. Řádky dodržující konvenci se seskupují přesněji a vše ostatní se vrátí k úvodnímu slovesu. Repozitář s běžnými zprávami commitů ve tvaru vět stále produkuje použitelný návrh.

Jak to získám automaticky ze svého repozitáře?

Pro jednorázové použití `git log --pretty=format:%s v1.2.0..HEAD` dá přesně vstup, který toto očekává. Pro něco průběžného git-cliff a github-changelog-generator oba staví soubor changelogu v CI z historie tvých commitů, a Changeloop sepíše záznam orientovaný na uživatele pro každý sloučený pull request a podrží ho pro recenzi.

Proč je můj výstup plný Ostatní?

Úvodní slovesa neodpovídala ničemu známému, což obvykle znamená předměty commitů začínající podstatným jménem nebo ID tiketu. Buď je uprav v poli před generováním, nebo řádky Ostatní přesuň ručně poté.

Další čtení: od conventional commits k changelogu, o tom, co formát commitu kupuje a kde končí.