Changelog generaator

Loo struktureeritud Keep a Changelog stiilis muudatuste logisid versioonide kaupa.

Parsiti 0 Conventional Commits kirjet

Changelog generaator — Üksikasjalik juhend

Kategooria: DevOps ja standardid 100% lokaalselt brauseris

Muudatuste logi generaator (Changelog Generator) parsib tooreid Git-i commit-logisid ja vormindab need standardseks, väljalaskevalmis `CHANGELOG.md` dokumentatsiooniks. See mõistab nii Conventional Commits süntaksit kui ka tavalisi commit-sõnumeid.

Commit-id rühmitatakse struktureeritud kategooriatesse: Features, Bug Fixes, Performance Improvements, Documentation ja Refactoring. Seadistage väljalaske versioonisildid ja kuupäevad ning filtreerige merge-commit'id ühe klõpsuga Markdown-ekspordiks.

#changelog #git #release #version #history

Põhifunktsioonid ja võimalused

  • Parsib otse terminali käsu `git log --oneline` väljundit
  • Liigitab commit-kirjed automaatselt Conventional Commit tüüpide järgi (feat, fix, perf, docs)
  • Konfigureeritavad väljalaske versioonisildi ja kuupäeva päised, mis järgivad Keep a Changelog standardeid
  • Filtreerib välja müra tekitavad merge-commit'id ja väljastab puhta, kopeeritava Markdowni

Kuidas kasutada

  1. 1

    Käivitage repositooriumi terminalis käsk `git log --oneline` ja kleepige logid sisendväljale.

  2. 2

    Sisestage sihtversioon (nt `v1.2.0`) ja valige väljalaskekuupäev.

  3. 3

    Vaadake kategooriatesse jaotatud väljalaskemärkmed üle ning klõpsake nupul Copy või laadige alla `CHANGELOG.md`.

Levinud kasutusjuhud

  • → Väljalaskemärkmete koostamine GitHub Releases jaoks enne toodanguuuenduste juurutamist
  • → Tsentraliseeritud ajaloolise CHANGELOG.md faili haldamine avatud lähtekoodiga repositooriumides
  • → Tehniliste commit-sõnumite teisendamine loetavaks muudatuste logiks toote sidusrühmadele

Seotud tööriistad

Korduma kippuvad küsimused ja privaatsus

Kuidas eraldada commit-id alates viimasest väljalaskesildist?

Käivitage oma terminalis käsk `git log <previous-tag>..HEAD --oneline`, et eraldada ainult pärast eelmist väljalaset tehtud commit'id.

Kuidas klassifitseeritakse mitte-reeglipärased commit-id?

Commit-id, millel puuduvad tavapärased eesliited, rühmitatakse jaotisse "Other Changes", tagades, et ükski commit-info ei lähe kaduma.