Создание журналов изменений и заметок о выпуске
Узнайте, как создавать понятные журналы изменений и автоматические заметки о выпуске на основе истории Git и соглашений о коммитах.
«Создание журналов изменений и заметок о выпуске» — бесплатный урок Git & GitHub Professional Workflow на CoddyKit. Это урок 4 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения Git & GitHub Professional Workflow, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс Git & GitHub Professional Workflow содержит 4 уроков всего.
Что такое журнал изменений
Журнал изменений — это отобранный, понятный человеку список важных изменений для каждой версии. Он хранится в файле вроде CHANGELOG.md в корне репозитория.
Зачем нужны журналы изменений
Пользователи и участники команды читают журналы изменений, чтобы понять:
- Новые возможности
- Исправления ошибок
- Изменения, нарушающие обратную совместимость
Они делают обновления безопаснее и быстрее.
Формат журнала изменений
Распространённое соглашение группирует записи под заголовками: Добавлено, Изменено, Исправлено, Удалено.
## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bugСоглашение о коммитах
Соглашение о коммитах использует такие префиксы, как feat:, fix: и BREAKING CHANGE:, чтобы инструменты могли автоматически создавать журналы изменений.
feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 supportСписок коммитов с момента тега
Можно просмотреть изменения с момента последнего выпуска, используя git log с диапазоном тегов.
git log v1.1.0..HEAD --onelineФорматирование журнала для заметок
Отформатируйте журнал в виде маркированных строк, подходящих для вставки в заметки о выпуске.
git log v1.1.0..HEAD --pretty=format:'- %s'Инструменты автоматического создания журналов изменений
Такие инструменты, как standard-version или conventional-changelog, читают коммиты, соответствующие соглашению, и создают журнал изменений вместе с обновлением версии.
npx standard-versionАвтоматически созданные GitHub заметки
При создании выпуска GitHub может автоматически создать заметки о выпуске на основе объединённых PR.
gh release create v1.2.0 --generate-notesКатегоризация с помощью меток
Файл .github/release.yml сопоставляет метки PR с разделами журнала изменений, поэтому заметки автоматически группируют исправления ошибок и новые возможности.
changelog:
categories:
- title: Features
labels: [feature]Проверка перед публикацией
Всегда читайте созданные заметки перед публикацией. Автоматизация составляет их черновик, но человек редактирует формулировки и выделяет изменения, нарушающие обратную совместимость.
Связь с выпусками
Связывайте каждую запись журнала изменений с её тегом Git и страницей выпуска, чтобы читатели могли перейти к точному сравнению изменений.
[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0Быстрая проверка
Проверьте, насколько хорошо вы поняли журналы изменений и заметки о выпусках.
Итоги
Вы научились создавать журналы изменений:
- Используйте формат журнала изменений
- Соглашение о коммитах обеспечивает автоматизацию
git log v1..HEADпозволяет предварительно просмотреть измененияgh release create --generate-notesсоздаёт черновик заметок на основе PR
Часто задаваемые вопросы
Урок «Создание журналов изменений и заметок о выпуске» бесплатный?
Да — полный текст урока «Создание журналов изменений и заметок о выпуске» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс Git & GitHub Professional Workflow, подпишись на CoddyKit PRO. Курс Git & GitHub Professional Workflow содержит 4 уроков всего.
Чему я научусь в уроке «Создание журналов изменений и заметок о выпуске»?
Узнайте, как создавать понятные журналы изменений и автоматические заметки о выпуске на основе истории Git и соглашений о коммитах. Ты практикуешь Git & GitHub Professional Workflow с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.
Нужен ли мне опыт, чтобы начать Git & GitHub Professional Workflow?
Предыдущий опыт не требуется. Git & GitHub Professional Workflow на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 4 из 4.
Сколько времени занимает урок «Создание журналов изменений и заметок о выпуске»?
Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.
Можно ли писать и запускать код в этом уроке Git & GitHub Professional Workflow?
Да. Каждый урок Git & GitHub Professional Workflow включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.
Все уроки этого курса
- Семантическое версионирование с тегами
- Создание и управление релизами
- Релизные ветки и срочные исправления
- Создание журналов изменений и заметок о выпуске