Ceph项目稳定分支补丁提交规范指南

Ceph项目稳定分支补丁提交规范指南

ceph Ceph is a distributed object, block, and file storage platform 项目地址: https://gitcode.com/gh_mirrors/ce/ceph

前言

在Ceph分布式存储系统的开发维护过程中，向稳定分支提交补丁(backport)是一项重要但需要谨慎处理的工作。本文将详细介绍Ceph项目中向稳定分支提交补丁的规范流程和最佳实践，帮助开发者正确完成这一过程。

基本原则

向稳定分支提交补丁时，必须遵循以下核心原则：

1. 最小化修改：每个修改都应尽可能精简，只解决特定问题
2. 风险意识：任何修改都可能引入新的问题，必须权衡利弊
3. 必要性证明：必须明确说明为什么需要在特定稳定分支中进行修复

在提交补丁时，需要清晰说明：

• 修复的具体问题是什么
• 为什么这是最简洁的修复方式
• 为什么需要在特定稳定分支中进行修复

补丁选取规则

Ceph项目制定了一套严格的补丁选取规则，确保稳定分支的质量：

1. 主分支优先：所有修复必须先合并到主分支(main)
2. 严格cherry-pick：稳定分支的提交必须从主分支cherry-pick而来
3. 完整性检查：在cherry-pick前，需检查主分支是否有后续修复提交
4. 完整移植：必须移植主分支PR中的所有相关提交
5. 规范操作：必须使用git cherry-pick -x命令
6. 冲突说明：必须详细记录所有手动解决的冲突

工作流程管理

对于需要移植到多个稳定分支的修改，必须使用跟踪问题(tracker issue)来管理：

1. 主分支跟踪问题：在主分支修复时创建，记录需要移植的稳定分支
2. 状态管理：主分支合并后，将状态改为"Pending Backport"
3. 移植跟踪问题：为主分支跟踪问题创建对应的移植跟踪问题

自动化工具使用

Ceph提供了两个自动化脚本简化移植过程：

1. backport-create-issue脚本

用于自动创建移植跟踪问题：

• 位于主分支的src/script/backport-create-issue
• 依赖Python 3和python-redmine库
• 使用示例：backport-create-issue 55555

2. ceph-backport.sh脚本

用于自动化整个移植过程：

• 位于主分支的src/script/ceph-backport.sh
• 自动创建移植分支、提交PR、更新跟踪问题
• 使用示例：ceph-backport.sh 55555

冲突解决指南

当cherry-pick出现冲突时：

1. 手动解决所有冲突
2. 完成cherry-pick操作(git cherry-pick --continue)
3. 在提交信息中详细记录：
   • 冲突的文件
   • 冲突的具体内容
   • 解决方案说明

示例冲突记录格式：

Conflicts:
    src/foo/bar.cc
- mimic分支缺少blatz功能，改用batlo替代

PR标记与合并

创建移植PR后需要：

1. 设置正确的里程碑(Milestone)标签
2. 继承主分支PR的组件(component)标签
3. 等待审查和测试，不要自行合并

特殊情况处理

如果问题仅存在于稳定分支而不在主分支，可能是以下情况：

1. 错误移植引入：之前的移植引入了问题
2. 大规模重构：主分支的修复方式无法移植
3. 已有可移植修复：主分支已有可cherry-pick的修复

针对不同情况应采取不同策略，并在提交信息中详细说明原因。

结语

遵循这些规范可以确保Ceph稳定分支的质量和稳定性，减少回归风险，同时提高审查效率。作为开发者，理解并遵守这些流程是对Ceph项目的重要贡献。

ceph Ceph is a distributed object, block, and file storage platform 项目地址: https://gitcode.com/gh_mirrors/ce/ceph