Implementace protokolu změn

3 min

Koncept protokolu změn je dostatečně jednoduchý: Jedná se o soubor se seznamem změn provedených v projektu, obvykle v pořadí kalendářních dat. Typickým rozpisem je oddělit seznam verzí a pak v rámci každé verze zobrazit:

Přidání funkcí
Změněné nebo vylepšené funkce
Odstraněné funkce

Některé týmy budou publikovat protokoly změn jako blogové příspěvky; ostatní vytvoří soubor CHANGELOG.md v úložišti GitHub.

Automatizované nástroje protokolu změn

I když je možné protokoly změn vytvářet a ručně udržovat, můžete zvážit použití automatizovaného nástroje pro vytváření protokolu změn. Alespoň jako výchozí bod.

Použití nativních příkazů GitHubu

Příkaz git log může být užitečný pro automatické vytváření obsahu. Příklad: Vytvoření nového oddílu na verzi:

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

Protokol změn Gitu

Jedním standardním nástrojem je gitchangelog. Tento nástroj je založený na Pythonu.

Generátor protokolu změn GitHubu

Dalším standardním nástrojem se říká github-changelog-generator.

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

Tento nástroj je založený na gemu.

Měli byste použít automaticky generovaná data na základě protokolů?