Привет мир! Встречайте Finch, настраиваемый инструмент командной строки, встроенный в Swift, предназначенный для простого создания и форматирования журналов изменений. Финч, познакомься с миром. 🤝

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

К сожалению, у разработчиков и так более чем достаточно забот, из-за чего журналы изменений часто остаются несвоевременными, полностью забытыми или, в лучшем случае, сложными для стилистического поддержания между различными членами команды. Эти проблемы и вдохновили на создание Зяблика.

Используя хорошо сформированные и преднамеренные сообщения коммитов Git, Finch может очень легко преобразовать ваши коммиты Git в последовательно отформатированный и полностью автоматизированный журнал изменений. Сообщения фиксации служат базовыми данными, которые затем передаются через систему форматирования в соответствии с настраиваемой конфигурацией вашего проекта. Единственное требование, которое есть у Финча, — это использование некоторой относительно небольшой дисциплины сообщений коммитов — простое использование сообщений коммитов с префиксом «тег». Например:

git commit -m '[feature] Add the bells. And the whistles'

Только с этим — и в соответствии с любыми соглашениями, которые ваша команда хотела бы использовать — Finch может помочь вам автоматизировать ваши внутренние и внешние журналы изменений, предоставив столько подробностей или полировки, сколько необходимо. Все, что вам нужно сделать, это запустить finch compare, а Финч позаботится обо всем остальном.

Проверьте это на https://github.com/namolnad/Finch и дайте мне знать, что вы думаете!