Implementowanie dziennika zmian
Koncepcja dziennika zmian jest na tyle prosta: jest to plik zawierający listę zmian wprowadzonych w projekcie, zwykle w kolejności daty. Typowy podział polega na oddzieleniu listy wersji, a następnie w każdej wersji pokaż:
- Dodano funkcje
- Zmodyfikowane/ulepszone funkcje
- Usunięte funkcje
Niektóre zespoły będą publikować dzienniki zmian jako wpisy w blogu; inne osoby będą tworzyć plik CHANGELOG.md w repozytorium GitHub.
Automatyczne narzędzia dziennika zmian
Dzienniki zmian można tworzyć i utrzymywać ręcznie, ale warto rozważyć użycie zautomatyzowanego narzędzia do tworzenia dziennika zmian. Przynajmniej jako punkt wyjścia.
Korzystanie z natywnych poleceń usługi GitHub
Polecenie dziennika git może być przydatne do automatycznego tworzenia zawartości. Przykład: utwórz nową sekcję na wersję:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Dziennik zmian usługi Git
Jednym ze standardowych narzędzi jest gitchangelog. To narzędzie jest oparte na języku Python.
Generator dzienników zmian usługi GitHub
Innym standardowym narzędziem jest github-changelog-generator .
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
To narzędzie jest oparte na platformie Gem.
Czy należy używać automatycznie wygenerowanych danych opartych na dziennikach?
Preferencje zawsze należy unikać dumpingu wpisów dziennika do dziennika zmian. Dzienniki są "hałaśliwe", więc łatwo jest wygenerować bałagan, który nie jest pomocny.