Conventional Changelog项目中BREAKING CHANGE的正确使用方式
2025-05-28 17:58:59作者:丁柯新Fawn
在Conventional Changelog项目中,提交消息的格式规范对于自动化版本管理和变更日志生成至关重要。最近发现一个常见的错误使用模式,值得开发者们特别注意。
问题背景
许多开发者习惯在提交消息中使用分隔线(如------)来区分不同部分,特别是在包含Co-authored-by等协作信息时。然而,当这种格式与BREAKING CHANGE结合使用时,可能会导致自动化工具无法正确识别重大变更。
错误示例
feat: test message
---------
Co-authored-by: Mee <me.e@me.com>
BREAKING CHANGE: test
这种格式虽然看起来清晰,但实际上会导致semantic-release等工具的commit-analyzer无法正确识别BREAKING CHANGE关键字,从而影响版本号的自动升级和变更日志的生成。
正确格式
正确的提交消息格式应该是:
feat: test message
BREAKING CHANGE: test
---------
Co-authored-by: Mee <me.e@me.com>
关键要点
- BREAKING CHANGE位置优先:重大变更说明必须放在分隔线之前,确保工具能够正确解析
- 协作信息后置:
Co-authored-by等协作信息可以放在分隔线之后 - 空行分隔:各部分之间使用空行进行适当分隔,保持可读性
为什么格式如此重要
Conventional Changelog和相关工具依赖于严格的提交消息格式来:
- 自动确定版本号升级类型(主版本/次版本/修订版)
- 生成结构化的变更日志
- 提供一致的版本管理体验
遵循正确的格式不仅能确保工具正常工作,还能保持项目提交历史的清晰和一致性。开发者应当特别注意这些规范,特别是在团队协作环境中,以确保自动化流程的顺畅运行。
登录后查看全文
热门项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0148- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0111
项目优选
收起
暂无描述
Dockerfile
731
4.73 K
Ascend Extension for PyTorch
Python
609
786
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1 K
1.01 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
433
392
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
145
237
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.15 K
148
暂无简介
Dart
983
251
Oohos_react_native
React Native鸿蒙化仓库
C++
348
401
昇腾LLM分布式训练框架
Python
166
197
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.67 K
986