Ведение файла changelog.txt в DVCS

Question

Я работаю над git-проектом, который использует множество веток. По большей части это был действительно отличный рабочий процесс. Я счастлив объединяться между ветками, люблю возможность выбирать код и весь жизненный цикл, который идет с git и другими dvcs.

У меня есть одна болевая точка, которая действительно причиняет боль. Как сохранить changelog.txt.

Я обнаружил, что больно всякий раз, когда я делаю слияние (часто changelog.txt конфликтует), и когда коммиты по сбору вишен, мне случайно удавалось захватывать изменения, которые действительно были нежелательны.

Я хотел бы видеть хороший ответ на эту проблему.

Answer 1

Вы можете комментировать свои комментарии регистрации и анализировать эти комментарии, как только вы будете готовы к отправке новой версии вашего программного обеспечения (я думаю, это наиболее распространенный вариант использования для предоставления журнала изменений).

Комментарии могут быть построены следующим образом (очевидно, только те, которые принадлежат коммитам, которые действительно изменяют что-то примечательное):

WHAT WHERE DESCRIPTION

куда WHAT может быть

• FIX для исправления ошибок
• CHG для изменений
• NEW для нового кода

WHERE должно быть одно слово, описывающее модуль где WHAT было сделано. Следуя этой информации, вы предоставляете DESCRIPTION описывая модификацию в глубине.

Как только вы будете готовы к отправке, получите журналы с последней версии и проанализируйте их. Журналы могут быть получены с помощью git log tagname_of_last_version.., Смотрите справочную страницу git log для вывода и параметров фильтрации.