CHANGELOG 生成器

粘贴 git log 输出的提交记录,按 Conventional Commits 规范(feat、fix、perf、refactor 等)自动分类,识别破坏性变更和作用域,生成 Keep a Changelog 或按类型分组的 Markdown 更新日志。可以加上版本号、日期、提交链接和版本对比链接,实时预览。

生成命令:git log v1.2.0..HEAD --no-merges --pretty=format:"%h %s"(把 v1.2.0 换成上一个版本的标签)

Conventional Commits 提交规范

格式:类型(作用域): 说明,例如 feat(auth): 支持短信验证码登录。类型后加 ! 或正文中写 BREAKING CHANGE: 表示不兼容的改动。

类型含义Keep a Changelog 分组语义化版本
feat新功能新增 Added次版本号 +1
fix修复问题修复 Fixed修订号 +1
perf / refactor性能优化 / 重构变更 Changed修订号 +1
revert回滚提交变更 Changed—
docs文档文档 Documentation—
security / sec安全修复安全 Security修订号 +1
deprecate / remove标记废弃 / 删除功能废弃 Deprecated / 移除 Removed—
chore、ci、test、build、style杂项、持续集成、测试、构建、格式通常不写进更新日志—

出现破坏性变更时主版本号 +1,有 feat 时次版本号 +1,否则修订号 +1。右侧统计会根据提交给出建议的下一个版本号。

CHANGELOG 生成器常见问题

CHANGELOG 生成器怎么使用?

用页面提示的 git log 命令导出提交记录并粘贴,在右侧填写版本号、上一版本、日期和仓库地址,选择 Keep a Changelog 或按类型分组、中英文标题,勾选是否显示哈希、隐藏杂项提交;预览确认后复制 Markdown 或下载 CHANGELOG.md。

CHANGELOG 怎么写?

按版本列出变更,每个版本分成新增、变更、修复、移除等小节,最新版本写在最上面,这就是 Keep a Changelog 的约定。

Conventional Commits 是什么?

一种提交说明规范,格式为 类型(作用域): 说明,如 feat(auth): 支持短信登录,方便自动生成更新日志和版本号。

怎么导出某个版本之后的提交?

执行 git log v1.2.0..HEAD --no-merges --pretty=format:"%h %s",把 v1.2.0 换成上一个版本标签。

下一个版本号怎么定?

有破坏性变更升主版本号,有新功能升次版本号,只有修复升修订号。

CHANGELOG 生成器的结果应怎样理解?

只解析每条提交的第一行(标题);合并提交会自动忽略;建议版本号按语义化版本规则推算,仅供参考。

输入内容会保存或发给外部服务吗?

提交记录只在浏览器本地处理,不会上传。

没有结果或操作失败时先检查什么?

很多提交被归入“其他”,说明它们没有使用 类型: 说明 的格式;生成链接需要填写完整的仓库地址。

相关工具

Diff 补丁查看器 · Git 命令速查表 · .gitignore 生成器 · package.json 生成器 · 全部开发工具