git-cliff 完整入门指南如何3步从 Git 提交快速生成专业 Changelog【免费下载链接】git-cliffA highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️项目地址: https://gitcode.com/gh_mirrors/gi/git-cliff为什么你需要 git-cliff还在每次发版时手动整理 CHANGELOG.md 吗git-cliff是一款开源、可高度定制的 Changelog 生成器它能读取你的 Git 提交历史按照 Conventional Commits 规范自动归类一键生成结构清晰、适合开源项目的专业 Changelog 文件。无论你是个人开发者还是团队维护者git-cliff 都能把写更新日志这件枯燥的事变成一条命令的事——而且它的 Changelog 模板完全可定制输出格式随你定义。项目热度10k Star 的 Changelog 生成工具在深入操作之前先看看社区对 git-cliff 的认可度项目 Star 数已突破10,000并保持着持续稳定的增长曲线是 Rust 生态中最受欢迎的 Changelog 工具之一。项目甚至为突破 10k Star 举办了限定纪念 T 恤活动足见其在开源社区的影响力第 0 步安装 git-cliff根据你的环境任选一种方式安装完整渠道见 website/docs/installation/index.md平台/方式安装命令macOS (Homebrew)brew install git-cliffRust 生态 (crates.io)cargo install git-cliffNode.js (npx 免安装)npx git-clifflatest详细说明分别位于 website/docs/installation/homebrew.md、website/docs/installation/crates-io.md 和 website/docs/installation/npm.md。 小技巧如果你不想 clone 仓库也可以直接把仓库克隆到本地体验git clone https://gitcode.com/gh_mirrors/gi/git-cliff第 1 步一条命令生成 Changelog进入任意一个 Git 仓库目录直接运行git cliff就这么简单git-cliff 会自动读取仓库根目录下的cliff.toml配置文件按配置解析 Conventional Commits如feat:、fix:、docs:把提交按类别分组渲染成 Markdown 并输出到终端默认写入CHANGELOG.md。生成的结果类似这样——按特性、修复、文档等分类一目了然## [1.0.0](https://github.com/you/your-project/compare/v0.9.0..v1.0.0) - 2026-09-21 ### ⛰️ Features * (cli) Add --latest flag to process commits from the latest tag * Support custom commit parsers with regex ### Bug Fixes * (config) Fix tag pattern not matching v-prefixed tags第 2 步初始化配置文件定制你的 Changelog默认行为不够个性一条命令即可初始化配置文件git cliff --init这会在当前目录生成 config/cliff.toml 格式的配置文件你可以参考项目自带的示例配置 cliff.toml。git-cliff 还内置了 11 种开箱即用的模板例如keepachangelogKeep a Changelog 标准格式github模拟 GitHub Releases 自动生成的格式detailed带提交链接的详细版minimal极简版unconventional面向不遵循规范的提交使用方式见 website/docs/usage/initializing.md# 用 Keep a Changelog 格式初始化 git cliff --init keepachangelog # 不创建文件直接用内置模板生成 git cliff --config detailed各模板的完整定义位于 examples/ 目录如 examples/github.toml、examples/keepachangelog.toml、examples/minimal.toml 等。配置文件的三大核心区块区块作用[changelog]Changelog 的头部/正文/页脚 Tera 模板控制最终排版[git]提交解析规则commit_parsers按正则把提交归入不同分组[remote.*]对接 GitHub/GitLab 等远程平台拉取 PR 和贡献者信息想深入了解官方文档website/docs/configuration/index.md模板语法website/docs/templating/syntax.md。第 3 步按版本 Tag 精准生成并自动升版真正的发版场景你需要控制生成哪个范围的 Changelog# 只处理未发布的提交 git cliff --unreleased # 为未发布的变更指定版本标签不实际打 tag git cliff --unreleased --tag 1.0.0 # 只处理最新 tag 之后的提交 git cliff --latest # 指定任意提交范围 git cliff v0.1.0..HEAD更棒的是git-cliff 内置语义化版本自动升级bump能力git cliff --bump规则很直白详见 website/docs/usage/bump-version.mdfix:提交 →PATCH 1如 1.0.0 → 1.0.1feat:提交 →MINOR 1如 1.0.0 → 1.1.0破坏性变更feat!:→MAJOR 1如 1.0.0 → 2.0.0配合--prepend还能把新版本条目自动插入已有 CHANGELOG.md 顶部完成生成 归档一条龙。所有命令行参数的完整清单见 website/docs/usage/args.md 和 website/docs/usage/examples.md。进阶玩法速览 多平台集成支持 GitHub、GitLab、Gitea、Bitbucket、Azure DevOps 远程元数据自动附 PR 链接和贡献者列表源码位于 git-cliff-core/src/remote/JSON 上下文输出git cliff --context将解析结果输出为 JSON方便接入 CI/CD 流水线核心库复用Rust 和 Python 生态可以直接引用 git-cliff-core 库把 Changelog 生成能力嵌入你的工具中更多用法示例website/docs/usage/examples.md总结3 步搞定专业 Changelog步骤命令结果1️⃣ 安装brew install git-cliff获得 git-cliff 命令2️⃣ 生成git cliff按 Conventional Commits 自动生成 Changelog3️⃣ 定制git cliff --init 编辑cliff.toml完全掌控格式、分组与版本策略从今天起把更新日志交给 git-cliff把时间留给真正重要的代码。⛰️【免费下载链接】git-cliffA highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️项目地址: https://gitcode.com/gh_mirrors/gi/git-cliff创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考