首页
/ Conventional Changelog项目中BREAKING CHANGE的正确使用方式

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>

关键要点

  1. BREAKING CHANGE位置优先:重大变更说明必须放在分隔线之前,确保工具能够正确解析
  2. 协作信息后置Co-authored-by等协作信息可以放在分隔线之后
  3. 空行分隔:各部分之间使用空行进行适当分隔,保持可读性

为什么格式如此重要

Conventional Changelog和相关工具依赖于严格的提交消息格式来:

  • 自动确定版本号升级类型(主版本/次版本/修订版)
  • 生成结构化的变更日志
  • 提供一致的版本管理体验

遵循正确的格式不仅能确保工具正常工作,还能保持项目提交历史的清晰和一致性。开发者应当特别注意这些规范,特别是在团队协作环境中,以确保自动化流程的顺畅运行。

登录后查看全文

项目优选

收起
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
471
465
kernelkernel
deepin linux kernel
C
32
16
atomcodeatomcode
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
2.09 K
218
ops-nnops-nn
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
700
1.4 K
docsdocs
暂无描述
Dockerfile
780
5.08 K
pytorchpytorch
Ascend Extension for PyTorch
Python
758
968
flutter_flutterflutter_flutter
本仓库是 Flutter SDK 与 Flutter Engine 的 OpenHarmony 适配版本,由 CPF-Flutter 团队维护。开发者可使用熟悉的 Flutter 技术栈开发 OpenHarmony 应用,3.35.7 及以后的适配版本可基于本仓库源码构建支持 OpenHarmony 的 Flutter Engine。
Dart
1.04 K
271
ops-transformerops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
880
2.03 K
mindquantummindquantum
MindQuantum is a general software library supporting the development of applications for quantum computation.
Python
183
111
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.11 K
682