Implementowanie dziennika zmian

  • 3 min

Dziennik zmian jest prosty: jest to plik zawierający listę zmian wprowadzonych w projekcie, zwykle uporządkowanych według daty. Typowy format pokazuje wersje, a dla każdej z nich wyświetla listę:

  • Dodano funkcje — nowe czynności, które można wykonać
  • Zmodyfikowane/ulepszone funkcje — elementy, które działają lepiej
  • Usunięte funkcje — elementy, które zostały usunięte

Niektóre zespoły publikują dzienniki zmian jako wpisy w blogu. Inni tworzą plik CHANGELOG.md w repozytorium GitHub.

Zautomatyzowane narzędzia dziennika zmian

Chociaż dzienniki zmian można tworzyć i obsługiwać ręcznie, możesz chcieć użyć zautomatyzowanego narzędzia, aby ci pomóc. Przynajmniej jako punkt wyjścia.

Korzystanie z natywnych poleceń git

Polecenie git log może ułatwić automatyczne tworzenie zawartości. Na przykład utwórz nową sekcję dla każdej wersji:

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Dziennik zmian usługi Git

Jednym z popularnych narzędzi jest gitchangelog. To narzędzie jest napisane w języku Python.

Generator dzienników zmian usługi GitHub

Innym popularnym narzędziem jest github-changelog-generator.

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

To narzędzie jest oparte na języku Ruby Gem.

Czy należy używać automatycznie wygenerowanych danych opartych na dziennikach?

Zwykle lepiej jest unikać kopiowania wpisów dziennika do dziennika zmian. Dzienniki zawierają zbyt wiele szczegółów technicznych, więc łatwo jest utworzyć mylący bałagan, który nie pomaga użytkownikom zrozumieć, co się zmieniło.