conventional-changelog中BREAKING CHANGE的正确使用格式
2025-05-28 01:18:45作者:翟萌耘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>
格式规范详解
- 首行:必须包含类型(如feat/fix等)和简要描述
- BREAKING CHANGE:必须紧接在首行之后,位于分隔线之前
- 分隔线:用于分隔主要内容和元数据(如Co-authored-by)
- 元数据:出现在分隔线之后
为什么格式如此重要
- 工具兼容性:semantic-release等工具会按照特定模式解析commit message
- 版本控制:只有正确格式的BREAKING CHANGE才会触发主版本号升级
- 变更日志:确保变更信息被正确归类到变更日志的相应部分
- 团队协作:统一的格式便于团队成员理解和维护
最佳实践建议
- 在团队中建立commit message规范
- 使用commitizen等工具辅助生成符合规范的commit message
- 在CI流程中加入commit message格式检查
- 对于大型变更,考虑在PR模板中加入commit message格式说明
遵循这些规范将大大提升项目的可维护性和自动化工具的使用效果。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
521
3.71 K
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
67
20
暂无简介
Dart
762
184
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.32 K
742
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
16
1
React Native鸿蒙化仓库
JavaScript
302
349
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1