git-cliff README

The project's README from github.com/orhun/git-cliff. As one markdown file: README.md.




Documentation | Website

git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. The changelog template can be customized with a configuration file to match the desired format.

animation

Documentation

Learn how to use git-cliff from the official documentation.

You can also check out the blog posts written by the community:

In The Media

Editor Support

Similar/Related Projects

Contributors

Thanks goes to these wonderful people ✨

Made with contrib.rocks.

Socials


License

Licensed under either of Apache License Version 2.0 or The MIT License at your option.

Copyright © 2021-2025, git-cliff contributors

git-cliff (orhun/git-cliff)

Searching Database…

12.3K ·GitHub
Что это такое?git-cliff — это генератор журнала изменений с широкими возможностями настройки, который создаёт файлы changelog на основе истории коммитов Git, следуя спецификации Conventional Commits и формату Keep a Changelog.
Это инструмент командной строки или библиотека?Это инструмент командной строки, написанный на Rust, который запускается внутри репозитория Git; это не библиотека, которую можно подключить в код.
Как его запустить?Установите git-cliff, следуя руководству Installation из официальной документации, затем запустите его в репозитории Git, чтобы он прочитал историю коммитов и создал файл changelog.
Нужно ли, чтобы мои коммиты следовали Conventional Commits, чтобы это работало?Лучше всего работает с Conventional Commits, но также поддерживает пользовательские парсеры на основе регулярных выражений (regex), чтобы обрабатывать коммиты, которые не следуют этому соглашению.
Как настроить внешний вид и содержимое changelog?Шаблон changelog можно настроить через файл конфигурации, так что можно задать любой нужный формат вместо фиксированной разметки.
Работает ли он с монорепозиториями?Да, есть документация от сообщества, посвящённая возможностям git-cliff для монорепозиториев: генерации changelog отдельно для каждого пакета или общего для всех.
Чем он отличается от таких инструментов, как clog-cli или cocogitto?Это один из нескольких инструментов для создания changelog на основе Conventional Commits (наряду с clog-cli, cocogitto, release-plz и другими), но git-cliff делает упор на широкую настройку шаблонов и разбор на основе regex, выходящий за рамки строгой спецификации Conventional Commits.
Можно ли запускать его в CI для автоматизации релизов?Да, проект часто используется в конвейерах релизов; в его собственном репозитории есть рабочие процессы CI (например, cd.yml) для автоматической генерации changelog и проверок релиза.
Creator
orhun
Size
19.4 MB
Stars
12.3K
Age
5y
Commits · 90 Days