Реализация журнала изменений

3 мин

Концепция журнала изменений достаточно проста: это файл с списком изменений, внесенных в проект, обычно в порядке даты. Типичная разбивка состоит в том, чтобы разделить список версий, а затем в каждой версии показать:

Добавленные функции
Измененные и улучшенные функции
Удаленные функции

Некоторые команды будут публиковать журналы изменений в виде записей блога; другие пользователи создадут файл CHANGELOG.md в репозитории GitHub.

Автоматизированный инструмент для ведения журнала изменений

Хотя журналы изменений можно создавать и поддерживать вручную, вам может потребоваться использовать средство автоматического создания журнала изменений. По крайней мере в качестве отправной точки.

Использование собственных команд GitHub

Команда журнала Git может быть полезна для автоматического создания содержимого. Пример: создайте новый раздел для каждой версии:

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

Журнал изменений Git

Одним из стандартных инструментов является gitchangelog. Это средство основано на Python.

Генератор журнала изменений GitHub

Другой стандартный инструмент называется github-changelog-generator.

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

Это средство основано на Gem.

Следует ли использовать автоматически созданные данные на основе журналов?