搜索你想找的开源项目

输入名称、用途或关键词,也可粘贴 GitHub 仓库链接

分享到微信

当前解读页的微信分享二维码

用微信扫一扫打开,点击右上角「···」分享给朋友或朋友圈。

手机上可截屏后,在微信扫一扫中从相册识别二维码。

orhun/git-cliff

开发工具

依据 Conventional Commits 和正则解析规则,从 Git 提交历史生成可自定义格式的变更日志。

12,486
364
Rust
Apache-2.0
创建于 5 年前

项目介绍

git-cliff 是一个用 Rust 编写的命令行工具,用来把 Git 提交历史转换成变更日志。它既能识别 Conventional Commits,也支持用正则写 自定义提交解析器,因此不完全遵循提交规范的团队也能按自己的规则筛选和分组提交。输出格式由配置文件和模板控制,可以做成与现有发布说明一致的样式,而不是固定模板。适合希望把 changelog 生成过程固定下来、避免手工维护 CHANGELOG 的维护者。

官方文档覆盖安装、用法示例、配置和模板 文档。项目还提供可单独集成的 Rust 库 crate git-cliff-core docs.rs。

快速使用

前置条件:有一个带提交历史的 Git 仓库,并按 安装指南 安装 git-cliff。Rust 用户可以从 crates.io 安装,项目也提供预编译二进制和 Docker 镜像。

在要生成日志的仓库根目录执行:

git-cliff --output CHANGELOG.md

命令会读取仓库历史,把生成的变更日志写入 CHANGELOG.md。如果默认模板不符合需求,可以创建配置文件并显式传入,再按配置和模板文档调整解析规则与输出格式 配置、模板。更完整的命令写法见 用法示例。

使用约束

生成日志的质量取决于提交信息与解析规则匹配的程度。使用 Conventional Commits 可以获得结构化的分组,但并非强制,自定义正则解析器同样可用。模板和输出格式都由配置驱动,通常需要先做一定的配置工作才能得到可用结果。项目采用 Apache-2.0 或 MIT 双许可证,用户可任选其一 许可证。

HotRepo 点评

在 2026-11-06 的 Rust 日榜中,git-cliff 当日新增 111 星,最好名次为第 7,说明它在 Rust 生态里持续受到关注。2021 年的一则 Hacker News 讨论获得 223 分和 51 条评论 讨论,评论者争论自动生成的变更日志是否“有总比没有好”,以及 Conventional Commits 的规范是否足够清晰 评论。这些是讨论中的观点,不是项目效果的实测结论,但指出了主要取舍:只有认真维护提交规范或解析规则时,工具才能发挥最大作用。

本文由 AI 根据项目 README 生成,更新于 ,以项目官方文档为准。

Hacker News 讨论

Git-cliff – Generate changelog files from the Git history
▲ 223 · 51 条评论 · 2021年9月5日