首页
/ conventional-changelog中BREAKING CHANGE的正确使用格式

conventional-changelog中BREAKING CHANGE的正确使用格式

2025-05-28 05:33:51作者:翟萌耘Ralph

在软件开发过程中,commit message的规范化对于版本管理和变更日志生成至关重要。conventional-changelog作为一款流行的commit message规范工具,对BREAKING CHANGE有特定的格式要求。

常见错误格式

许多开发者可能会写出类似以下的commit message:

feat: test message

---------

Co-authored-by: Mee <me.e@me.com>

BREAKING CHANGE: test

这种格式虽然看起来合理,但实际上会导致semantic-release等工具无法正确识别BREAKING CHANGE关键字,从而影响版本号的自动升级和变更日志的生成。

正确的BREAKING CHANGE格式

conventional-changelog要求BREAKING CHANGE必须出现在commit message的特定位置:

feat: test message

BREAKING CHANGE: test

---------

Co-authored-by: Mee <me.e@me.com>

格式规范详解

  1. 首行:必须包含类型(如feat/fix等)和简要描述
  2. BREAKING CHANGE:必须紧接在首行之后,位于分隔线之前
  3. 分隔线:用于分隔主要内容和元数据(如Co-authored-by)
  4. 元数据:出现在分隔线之后

为什么格式如此重要

  1. 工具兼容性:semantic-release等工具会按照特定模式解析commit message
  2. 版本控制:只有正确格式的BREAKING CHANGE才会触发主版本号升级
  3. 变更日志:确保变更信息被正确归类到变更日志的相应部分
  4. 团队协作:统一的格式便于团队成员理解和维护

最佳实践建议

  1. 在团队中建立commit message规范
  2. 使用commitizen等工具辅助生成符合规范的commit message
  3. 在CI流程中加入commit message格式检查
  4. 对于大型变更,考虑在PR模板中加入commit message格式说明

遵循这些规范将大大提升项目的可维护性和自动化工具的使用效果。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
263
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
869
514
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
130
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
295
331
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
333
1.09 K
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
18
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0
kernelkernel
deepin linux kernel
C
22
5
WxJavaWxJava
微信开发 Java SDK,支持微信支付、开放平台、公众号、视频号、企业微信、小程序等的后端开发,记得关注公众号及时接受版本更新信息,以及加入微信群进行深入讨论
Java
829
22
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
601
58