В словаре Даля
м. франц. дневник, поденная записка. Журнал заседаний, деяник;
путевой, дорожный, путевник. Протокол присутственного места тот же
журнал, но считается важнее, заключая в себе окончательное
постановление, решение и пишется уже на основании журнала. Члены
разбранились, и потребовали записки этого события в журнал. |
Повременное издание, недельное, месячное, выходящее по установленным
срокам; срочник. Журнальный, к нему относящ. Журналист м. чиновник
присутственного места, ведущий журналы. | Издатель, редактор
повременного издания. Журналистика ж. журнальная, срочная словесность.
Что такое журнал изменений?
Журнал изменений — это файл, который содержит общий, хронологически упорядоченный список изменений, внесенных в проект. Он часто организован по версии с указанием даты, после чего следует список добавленных, переработанных и удаленных функций.
В общем смысле, существует два способа делать записи в журнал изменений.
- Обычный способ: создайте текстовый файл и начните перечислять все внесенные вами изменения с указанием определенной даты.
- Выбор разработчика (он же вариант для ленивых): автоматическое создание списка изменений из ваших сообщений к коммитам. У меня для вас хорошие новости — именно об этом вы узнаете из этой статьи!
“Журнал изменений представляет собой программное протоколирование изменений, вносимых в большой проект. Таким проектом может быть веб-сайт или проект программного обеспечения. Обычно записи журнала изменений содержат информацию об исправлении ошибок, о новых возможностях и т.д.” (информация из Википедии).
Автоматическая генерация журнала изменений
В этой части мы вместе создадим наш первый журнал изменений.
Выполнив эту задачу, вы поймете, почему полезно делать коммиты, следуя определенным правилам.
Отличный и очевидный коммит не нуждается в модификациях и может быть добавлен в журнал изменений напрямую.
Если вы заинтересованы в создании необходимого файла без какой-либо персонализации или преобразований, я рекомендую первый способ; в противном случае лучше использовать второй.
Примечание: Некоторые веб-сайты, такие как Keep A Changelog, поясняют, что вы не должны создавать список изменений исключительно путем копирования и вставки ваших git-коммитов (см. простой способ). Я и в самом деле рекомендую избегать подобного способа, если вы работаете над профессиональным продуктом.
Однако в настоящее время существуют продвинутые генераторы, которые позволят вам преобразовывать ваши списки git-коммитов в журналы изменений (см. сложный способ).
Как создать журнал изменений (простой способ)
При использовании этого способа вам не потребуется никакой предварительной подготовки. Все, что вам нужно, — это ввести несколько команд в своем Git-репозитории.
В качестве простого напоминания: когда вы набираете команду “git log”, отображается список всех ваших коммитов.
Эта команда может принимать несколько параметров. Мы используем их, чтобы изменить вывод и получить его усовершенствованный вариант для создания журнала изменений.
Набрав следующую команду, вы получите вывод, в котором каждый коммит будет находиться на отдельной строке:
Теперь давайте посмотрим, что можно сделать с помощью следующей команды:
С ее помощью вы можете вывести список коммитов в нужном вам стиле.
“%s” здесь соответствует непосредственно заголовку коммита. Вы можете изменить строку, чтобы стиль отображения коммитов был таким, как вам нравится.
В нашем случае мы хотим создать список:
Мы сделали это! Мы создали простейший журнал изменений!
Примечание: если вы хотите продвинуться дальше и сохранять свой список изменений быстрее, то вместо копирования и вставки результата в файл, перенаправьте его в терминал, набрав .
Как создать журнал изменений (сложный способ)
Предварительная подготовка
Теперь мы рассмотрим сложный способ создания журнала изменений. Идея, лежащая в основе, остается прежней, но на этот раз мы используем другие инструменты.
Примечание: гайдлайны Git — это наборы правил для лучшего написания коммитов, которые помогают их структурировать.
Когда вы пользуетесь каким-либо гайдлайном при работе над проектом, вы можете использовать инструменты для создания журнала изменений. В большинстве случаев их использование предпочтительнее, поскольку они позволяют создавать журнал в формате markdown-разметки.
В этом примере мы будем использовать простой генератор, который работает с большинством гайдлайнов. Он называется “generate-changelog” и доступен через NPM (Node Package Manager).
Этот инструмент создает стилизованный список изменений, однако не обладает большим функционалом. Я решил использовать его, потому что это отличный пример для новичка
Если вам хочется продвинуться дальше, обратите внимание на список инструментов ниже
Вот те инструменты, которыми вы можете воспользоваться:
- Github Changelog Generator;
- Git Chglog;
- Auto Changelog;
- Conventional Changelog.
Чтобы установить пакет себе на компьютер, введите в терминале следующую команду:
Установка закончена!
Как использовать инструмент
Чтобы заставить этот пакет работать, вам нужно следовать гайдлайнам по использованию такого шаблона: “тип (категория): описание ”. В этом примере я буду использовать репозиторий Angular.js на GitHub.
Теперь вы можете ввести команду в своем терминале внутри репозитория GitHub:
Файл “CHANGELOG.md” будет создан автоматически и заполнен вашими журнальными записями в markdown-формате.
Ниже вы можете найти пример вывода (с помощью программы чтения, поддерживающей markdown, такой как GitHub):
Список изменений, созданный автоматически с помощью инструмента generate-changelog
Где их искать?
Журналы изменений повсюду! Зачастую они различаются по стилю и месту расположения, но есть буквально в каждом проекте.
Я создал короткий список нескольких мест, где вы можете найти журналы изменений:
- Пост в блоге. Список изменений может быть представлен в виде статьи, излагающей содержание самых недавних фич.
- Файл CHANGELOG.md в репозитории GitHub.
- Раздел “Журнал изменений” (“Changelog”) вашего любимого сайта/ПО. Вот пример инструмента управления задачами TickTick.
- Раздел “Что нового?” в Android Google Play и iOS AppStore.
Раздел “Что нового” для приложения TickTick на Android
Раздел “Что нового” для приложения TickTick на iOS
В словаре Д.Н. Ушакова
ЖУРНА́Л, журнала, ·муж. (·франц. journal — Дневник, газета).1. Периодическое издание в виде книжки, содержащей статьи, художественные произведения, иллюстрации. Еженедельный иллюстрированный журнал. Толстые литературные журналы выходят ежемесячно. Заграничный технический журнал. Модный журнал (периодическое издание, содержащее рисунки и выкройки модных костюмов, нарядов).2. Дневник, периодическая запись событий, происшествий в особой тетради (·устар. ). Он вел путевой журнал.3. Шнуровая книга в учреждении для записи каких-нибудь действий, решений, постановлений (·канц. ). Судовой журнал. Журнал заседаний. Вахтенный журнал. Журнал военных действий.| книга для записи входящих и исходящих бумаг (·канц. ). Журнал входящих.4. Бухгалтерская книга для ежедневной записи денежных операций (·бух. ).
