git branch 规范

概述

各个项目中只能 有且仅有 以下分支：

  • 主要分支
    • main ：主分支，代码库应该有一个、且仅有一个主分支。所有提供给用户使用的正式版本，都在这个主分支上发布。(也叫 master，本文的 main 指代 master/main )
    • dev ：开发分支，永远是功能最新最全的分支
  • 临时分支
    • feature-x ：新功能分支，它是为了开发某种特定功能，从develop分支上面分出来的。
    • release-x ：预发布分支，指发布正式版本之前（即合并到main分支之前），我们可能需要有一个预发布的版本进行测试。
    • fixbug-x ：修补bug分支，修复线上bug分支

分支命名

  • 当 禅道 里面的任务预计工时超过 8 个时(包含8)，则需要根据本命名规则新开分支，小于 8 则直接在 dev 上修改提交。
  • 单词之间用 - 连接， 以 禅道 任务494 搭建疫苗系统 张三 开发 为例，分支的命名应该为：
// 任务
feature-zhangsan-task-494

// bug
fixbug-zhangsan-bug-494

// release
release-zhangsan-version1.0

主分支main

代码仓库有且仅有一个主分支，所有提供给用户使用的正式版本，都在这个主分支上发布。Git主分支的名字，默认叫做main。自动建立的，版本库初始化以后，默认就是在主分支在进行开发。团队成员从主分支(main)获得的都是处于可发布状态的代码。

git

开发分支develop

作为日常开发的分支叫做develop分支。开发分支上应该总能获得到最新开发进展的代码，通常用来发布重大版本。如果想正式对外发布，就在main分支上，对develop分支进行"合并"（merge）。

git

  • Git创建 develop 分支的命令：
git checkout -b develop main
  • 将 develop 分支发布到main分支的命令：
　# 切换到main分支
　git checkout main

　# 对develop分支进行合并
　git merge -no-ff develop

-no-ff 的意思是：默认情况下，Git执行"快进式合并"（fast-farward merge），会直接将main分支指向develop分支。

git

使用 -no-ff 参数后，会执行正常合并，在main分支上生成一个新节点。为了保证版本演进的清晰，我们希望采用这种做法。关于合并的更多解释：Understanding the Git Workflowopen in new window

git

临时分支

前面讲到版本库的两条主要分支：main和develop。前者用于正式发布，后者用于日常开发。其实，常设分支只需要这两条就够了，不需要其他了。

但是，除了常设分支以外，还有一些临时性分支，用于应对一些特定目的的版本开发。临时性分支主要有三种：

  • 功能（feature）分支
  • 预发布（release）分支
  • 修补bug（fixbug）分支

这三种分支都属于临时性需要，使用完以后，应该删除，使得代码库的常设分支始终只有main和develop。

功能分支feature-x

接下来，一个个来看这三种"临时性分支"。

第一种是功能分支，它是为了开发某种特定功能，从develop分支上面分出来的。开发完成后，要再并入develop。

git

功能分支的名字，可以采用feature-*的形式命名。

创建一个功能分支：

git checkout -b feature-x develop

开发完成后，将功能分支合并到develop分支：

git checkout develop
git merge -no-ff feature-x

删除feature分支：

git branch -d feature-x

预发布分支release-x

第二种是预发布分支，它是指发布正式版本之前（即合并到main分支之前），我们可能需要有一个预发布的版本进行测试。

预发布分支是从develop分支上面分出来的，预发布结束以后，必须合并进develop和main分支。它的命名，可以采用release-*的形式。

创建一个预发布分支：

git checkout -b release-1.2 develop

确认没有问题后，合并到main分支：

git checkout main
git merge -no-ff release-1.2
# 对合并生成的新节点，做一个标签
git tag -a 1.2

再合并到develop分支：

git checkout develop
git merge -no-ff release-1.2

最后，删除预发布分支：

git branch -d release-1.2

修补bug分支

最后一种是修补bug分支。软件正式发布以后，难免会出现bug。这时就需要创建一个分支，进行bug修补。

修补bug分支是从main分支上面分出来的。修补结束以后，再合并进main和develop分支。它的命名，可以采用fixbug-*的形式。

git

创建一个修补bug分支：

git checkout -b fixbug-0.1 main

修补结束后，合并到main分支：

git checkout main
git merge -no-ff fixbug-0.1
git tag -a 0.1.1

再合并到develop分支：

git checkout develop
git merge -no-ff fixbug-0.1

最后，删除"修补bug分支"：

git branch -d fixbug-0.1

发版流程

依次是：

  • 新功能开发完成，自测完成
  • 合并到 develop
  • 从 develop 开 release-x 分支
  • 提测
  • 测出来的问题就在 release-x 上修复
  • 测试通过，申请发版，从 release-x 上发
  • 发完后，将 release-x 合并回 develop main(打tag)
  • 删除release-x

git

bug修复流程

依次是：

  • 从 main 开 fixbug-x 分支
  • 在 fixbug-x 修复bug，自测完成
  • 将 fixbug-x 合并到 develop
  • 从 develop 开 release-x 分支
  • 提测
  • 测出来的问题就在 release-x 上修复
  • 测试通过，申请发版，从 release-x 上发
  • 发完后，将 release-x 合并回 develop main(打tag，必要时)
  • 删除release-x
  • 删除 fixbug-x

git

Last Updated:
Contributors: heyuan