Changelog-generaattori

Luo selkeä Keep a Changelog -standardin mukainen muutosloki Git-commit-viesteistä.

0 Conventional Commits -committia jäsennetty

Tietoja: Changelog-generaattori — Yksityiskohtainen opas

Kategoria: DevOps ja standardit 100 % paikallisesti selaimessa

Muutoslokigeneraattori (Changelog Generator) jäsentää raa'at Git-kommitointilokit ja muotoilee ne standardoiduksi, julkaisuvalmiiksi `CHANGELOG.md`-dokumentaatioksi. Se ymmärtää sekä Conventional Commits -syntaksia että tavallisia kommitointiviestejä.

Kommitit ryhmitellään jäsenneltyihin kategorioihin: ominaisuudet (Features), bugikorjaukset (Bug Fixes), suorituskykyparannukset (Performance Improvements), dokumentaatio (Documentation) ja refaktorointi (Refactoring). Voit määrittää julkaisuversiotunnisteet ja päivämäärät sekä suodattaa merge-kommitit pois yhdellä napsautuksella tapahtuvaa Markdown-vientiä varten.

#changelog #git #release #version #history

Keskeiset ominaisuudet ja toiminnot

  • Jäsentää suoraan terminaalin natiivin `git log --oneline` -komennon tulosteen
  • Luokittelee kommitit automaattisesti Conventional Commit -tyyppien mukaan (feat, fix, perf, docs)
  • Määritettävissä olevat julkaisuversion tunnisteet ja päivämääräotsikot Keep a Changelog -standardin mukaisesti
  • Suodattaa ylimääräiset merge-kommitit pois ja tuottaa siistiä, kopioitavaa Markdown-koodia

Käyttöohjeet

  1. 1

    Suorita `git log --oneline` tietovarastosi terminaalissa ja liitä lokit syötekenttään.

  2. 2

    Syötä kohdejulkaisuversio (esim. `v1.2.0`) ja valitse julkaisupäivämäärä.

  3. 3

    Tarkista luokitellut julkaisutiedot ja napsauta Kopioi tai lataa `CHANGELOG.md`.

Yleiset käyttökohteet

  • → Julkaisutietojen (release notes) kokoaminen GitHub Releases -julkaisuja varten ennen tuotantopäivityksiä
  • → Keskitetyn, historiallisen CHANGELOG.md-tiedoston ylläpito avoimen lähdekoodin tietovarastoissa
  • → Yksityiskohtaisten teknisten kommittien muuntaminen selkeäksi muutoslokiksi tuotteen sidosryhmille

Vastaavat työkalut

Usein kysytyt kysymykset ja tietosuoja

Miten voin poimia kommitit edellisen julkaisutunnisteen jälkeen?

Suorita terminaalissasi `git log <previous-tag>..HEAD --oneline` eristääksesi vain ne kommitit, jotka on tehty edellisen julkaisun jälkeen.

Miten ei-tavanomaiset kommitit luokitellaan?

Kommitit, joista puuttuu conventional-etuliite, ryhmitellään "Other Changes" -osion alle, jotta mikään kommittitieto ei jää huomaamatta.