Как пользоваться: Генератор Changelog
- Выполните команду
git logиз блока выше в вашем репозитории и вставьте результат (хеш и заголовок в каждой строке). - Введите текущую версию: версия релиза подскажется по коммитам, или укажите свою.
- Выберите заголовки Conventional или Keep a Changelog и добавьте URL репозитория, чтобы хеши коммитов стали ссылками.
- Скопируйте Markdown в начало вашего
CHANGELOG.mdили в описание релиза на GitHub.
Conventional Commits за 30 секунд
Заголовок каждого коммита начинается с типа, необязательной области (scope) и описания: feat(cart): add coupon field. Символ ! после типа или области, либо заметка BREAKING CHANGE: помечают критическое изменение.
| Тип | Раздел | Повышение версии |
|---|---|---|
feat | Новые возможности / Added | Minor |
fix | Исправления / Fixed | Patch |
perf | Производительность | Patch |
feat!, BREAKING CHANGE | Breaking Changes | Major |
refactor, docs, style, test, build, ci, chore | Прочее / скрыто | Нет |
revert | Откаты | Patch |
Keep a Changelog
Keep a Changelog группирует записи для людей по разделам Added, Changed, Deprecated, Removed, Fixed, Security: новые релизы идут первыми, а вверху есть раздел Unreleased. Выбирайте этот стиль, если changelog читают пользователи, а не разработчики.
От changelog до релиза
Проверьте предложенную версию в Semantic Version Calculator, обновите version в вашем package.json, затем создайте тег и отправьте релиз. Команды есть в Git Command Generator. Workflow GitHub Actions может собирать и публиковать релиз на каждый тег.
Также ищут как: changelog из conventional commits, генератор changelog.md, keep a changelog генератор, генератор release notes, conventional commits генератор, git log в changelog, список изменений версии.
Инструменты, которые хорошо сочетаются с Генератор Changelog
- Конструктор Conventional Commits — Пишите сообщения коммитов по спецификации Conventional Commits и не запоминайте её наизусть.
- Генератор README — Заполните несколько полей и получите аккуратный README.md, готовый для GitHub: бейджи, установка, пример использования, таблица настроек, переменные окружения, план развития и лицензия.
- Валидатор YAML — Вставьте файл Docker Compose, манифест Kubernetes, workflow GitHub Actions или любой YAML, чтобы найти ошибку, поймать типичные ловушки и получить аккуратно отформатированную версию.
- Генератор YAML для Kubernetes — Укажите имя приложения, образ и порт, и вы получите готовый к продакшену YAML для Kubernetes: Deployment с пробами, лимитами ресурсов и защищённым security context, а также выбранные вами Service, Ingress с TLS, ConfigMap, Secret и HorizontalPodAutoscaler — всё в одном файле, готовом для kubectl apply.
Часто задаваемые вопросы
В каком формате вставлять git log?
git log --pretty=format:"%h %s". Просто заголовки коммитов без хешей тоже подойдут. Merge-коммиты пропускаются автоматически.