Ugrás a tartalomhoz
100% helyi

Changelog generátor

Egy beillesztett git log átalakítása csoportosított, olvasható changelogvá.

Bemenet
Kimenet

Changelog generátor

Illeszd be a "git log" vagy a "git log --oneline" kimenetét, és ez az eszköz egy olyan changelogvá alakítja azt, amelyet közvetlenül egy release-be, egy CHANGELOG.md fájlba vagy egy pull request leírásba bemásolhatsz. Mind az alapértelmezett többsoros git log formátumot (Author: és commit fejlécekkel), mind a kompakt egysoros formátumot olvassa, így közvetlenül a terminálodból másolhatsz.

A commitok típus vagy hatókör szerint csoportosítva vannak. A típusok automatikus felismeréséhez a Conventional Commits előtagokból (feat, fix, docs, chore és további), vagy saját prefix-to-label leképezést adhatsz meg, ha a csapatod más konvenciót használ. A merge commitok és adminisztratív commitok kihagyhatók egy jelölőnégyzettel, így a changelog csak azt mutatja, ami ténylegesen megváltozott a felhasználók számára. Válassz a Keep a Changelog formátumot követő Markdown kimenetet, vagy egy egyszerű csoportosított listát markup nélkül.

Jelöld be a ticket linking opciót az olyan hivatkozások (pl. #123 vagy PROJ-42) URL link-ké alakításához, egy {id} placeholder-t tartalmazó URL sablon segítségével. A szerzők nevei automatikusan felvételre kerülnek, ha a log formátuma tartalmazza őket, a breaking changes pedig – amelyeket a típus után álló "!" vagy a commit body-ban a "BREAKING CHANGE:" fejléc jelöl – a saját szakaszba kerülnek az élére, ha a kiemelés be van kapcsolva. Adj hozzá egy verziót és dátumot egy megfelelő release fejléc generálásához.

Minden a böngésződben helyileg fut: a commit előzményed soha nem kerül feltöltésre sehova, ami privát repositoriumok esetén fontos. Az eredmény valós időben frissül, ahogy begépelsz vagy módosítasz egy opciót, másolhatod vagy txt fájlként letöltheted, vagy közvetlenül egy másik eszközbe elküldheted.

Gyakori kérdések

Mely git log formátumok támogatottak?
Az alapértelmezett "git log" kimenet (commit/Author/Date blokkok és egy behúzott üzenet) és a "git log --oneline" egyaránt. Közvetlenül a terminálodból másolj be.
Hogyan ismeri fel a commitok típusait?
Alapértelmezés szerint a Conventional Commits előtagokat keresi, mint a "feat:" vagy a "fix(scope):". Váltsd át egyéni előtagokra, és sorolj fel saját prefix=Label párokat, ha a projektje más konvenciót használ.
Hogyan működik a ticket linking?
Adj meg egy {id} placeholder-t tartalmazó URL sablont, mint például https://github.com/org/repo/issues/{id}. A commit tárgyában talált hivatkozások (pl. #123 vagy PROJ-42) bağlantákká alakulnak az adott sablon segítségével.
Mi számít breaking change-nek?
Egy típus után álló "!" (pl. "feat!:") vagy a commit body-ban egy "BREAKING CHANGE:" sor, amikor a teljes git log formátumot illeszel be. Ha a kiemelés be van kapcsolva, ezek a saját szakaszba kerülnek az élére.
A commit előzményed feltöltésre kerül valahova?
Nem. A changelog teljes egészében a böngésződben jön létre – a git log soha nem hagyja el az eszközödet.