Перейти к содержимому
Антон ГончаровРазработчик ИИ-систем

1 минута чтенияСделать за вечер

Сделать за вечер: черновик changelog из Git

Сделать за вечер: черновик changelog из Git

История коммитов обычно либо слишком техническая, либо слишком хаотичная. За вечер можно собрать скрипт, который превращает её в черновик понятного описания изменений.

1. Возьмите один репозиторий и ограничьте период: например, изменения между двумя тегами или за неделю. Получите список коммитов и затронутых файлов: git log --oneline --name-only.

2. Отбросьте шум: merge-коммиты, форматирование, обновления зависимостей без изменений поведения. Это важнее, чем кажется: модель не угадает, что считать полезным для пользователя.

3. Передайте оставшийся список модели с контекстом проекта. Попросите разделить изменения на «новое», «исправлено», «внутреннее» и не придумывать эффектов, которых нет в коммитах.

4. Сохраните результат в файл CHANGELOG-draft.md. Не публикуйте автоматически: это не генератор правды, а быстрый первый черновик.

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

Обсудить в канале
Сделать за вечер: черновик changelog из Git — блог Антона Гончарова