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 是一款高度可定制的更新日志生成工具,它根据你的 Git 提交历史生成更新日志文件,遵循 Conventional Commits 规范和 Keep a Changelog 格式。
这是命令行工具还是库?这是一个用 Rust 编写的命令行工具,需要在 Git 仓库中运行;它不是可以导入代码中的库。
我该怎么让它运行起来?请按照官方文档中的安装指南安装 git-cliff,然后在 Git 仓库中运行它,它会读取提交历史并生成一个更新日志文件。
我的提交信息必须遵循 Conventional Commits 才能用吗?它与 Conventional Commits 配合效果最好,但也支持基于正则表达式的自定义解析器,因此即使提交信息不遵循该规范,也能处理。
我如何自定义更新日志的外观和内容?更新日志模板可以通过配置文件进行自定义,你可以按照自己想要的格式来设置,而不是局限于固定的布局。
它支持多包仓库吗?支持。社区文档专门介绍了 git-cliff 在多包仓库方面的功能,可用于为每个包生成更新日志,或生成合并的更新日志。
它和 clog-cli、cocogitto 之类的工具有什么不同?它是几款基于 Conventional Commits 的更新日志工具之一(与 clog-cli、cocogitto、release-plz 等并列),但 git-cliff 更强调大量的模板自定义,以及超出严格 Conventional Commits 规范的基于正则表达式的解析。
我能在 CI 中运行它来自动化发布吗?可以。这个项目常用于发布流水线中;其自身仓库包含 CI 工作流(例如 cd.yml),用于自动生成更新日志和进行发布检查。
Creator
orhun
Size
19.4 MB
Stars
12.3K
Age
5y
Commits · 90 Days