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

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

2025-05-28 04:00:40作者:翟萌耘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格式说明

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

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
166
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
85
563
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
17
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
cjoycjoy
一个高性能、可扩展、轻量、省心的仓颉应用开发框架。IoC,Rest,宏路由,Json,中间件,参数绑定与校验,文件上传下载,OAuth2,MCP......
Cangjie
94
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
954
564