orhun/git-cliff

这是什么？

核心功能

• 01从 Git 提交历史生成更新日志。
• 02开箱即用地解析 Conventional Commits 格式的提交。
• 03支持基于正则表达式的自定义提交解析器。
• 04通过配置文件和模板自定义输出格式。
• 05以独立的 Rust 命令行程序发布。

适用场景

• 在发布流程中自动生成 CHANGELOG.md。
• 根据遵循 Conventional Commits 的提交生成发布说明。
• 为提交信息使用自定义格式的项目维护更新日志。

快速上手

1. 1

   按照官方文档中的安装指南安装 git-cliff

2. 2

   阅读官方文档中的使用示例

收录于专题

标签

常见问题

git-cliff 是什么？

一个用 Rust 编写的命令行工具，基于 Git 提交历史和 Conventional Commits 规范生成更新日志。 git-cliff 直接从仓库的 Git 提交历史生成更新日志文件。它会解析遵循 Conventional Commits 规范的提交信息，也支持通过基于正则表达式的自定义解析器处理其他格式的提交信息。

git-cliff 可以免费使用吗？用的什么许可证？

git-cliff 以 Apache-2.0 许可证开源。用于商业产品前，请先确认许可证条款。

git-cliff 还在维护吗？

活跃维护中。git-cliff 最近一次提交是在 2026年11月2日。

git-cliff 适合用来做什么？

在发布流程中自动生成 CHANGELOG.md。 根据遵循 Conventional Commits 的提交生成发布说明。 为提交信息使用自定义格式的项目维护更新日志。

git-cliff 怎么安装和运行？

按照官方文档中的安装指南安装 git-cliff 阅读官方文档中的使用示例

在哪里获取 git-cliff？

源代码和安装说明在 GitHub 上：https://github.com/orhun/git-cliff