介绍一个成功的 Git 分支模型

在这篇文章中,我提出一个开发模型。我已经将这个开发模型引入到我所有的项目里(无论在工作还是私人)已经一年有余,并且它被证明是非常成功的。我打算写这些已经很久了,但我一直找不到时间来做,现在终于有时间了。我不会讲任何项目的具体细节,仅是关于分支策略和释放管理相关内容。

它主要体现了Git对我们源代码版本的管理。

为何是Git 对于Git与其他集中式代码管理工具相比的优缺点的全面讨论,请参见这里。这样的争论总是喋喋不休。作为一个开发者,与现今的其他开发工具相比较,我更喜欢Git。Git真得改变了开发者对于合并和分支的思考。我曾经使用经典的CVS/Subversion,然而每次的合并/分支和其他行为总让人担惊受怕(“小心合并里的冲突,简直要命!”)。

但是对于Git来说,这些行为非常简单和搞笑,它们被认为是日常工作中的核心部分。例如,在很多CVS/Subversion里,分支与合并总是在后面的章节中被讨论(对于高级用户使用),然而在每个Git中,在第3章就已经完全涵盖了(作为基础)。

简单和重复的特性带来的结果是:分支与合并不再是什么可以害怕的东西。分支/合并被认为对于版本管理工具比其他功能更重要。

关于工具,不再多说,让我们直接看开发模型吧。这个模型并不是如下模型:在管理软件开发进度方面,面对每个开发过程,每个队员必须按一定次序开发。

分布式而非集中式 对于这种分支模型,我们设置了一个版本库,它运转良好,这是一个"事实上" 版本库。不过请注意,这个版本库只是被认为是中心版本库(因为Git是一个分布式版本管理系统,从技术上来讲,并没有一个中心版本库)。我们将把这个版本库称为原始库,这个名字对所有的Git用户来说都很容易理解。

每个开发者都对origin库拉代码和提交代码。但是除了集中式的存取代码关系,每个开发者也可以从子团队的其他队友那里获得代码版本变更。例如,对于2个或多个开发者一起完成的大版本变更,为了防止过早地向origin库提交工作内容,这种机制就变得非常有用。在上述途中,有如下子团队:Alice和Bob,Alice和David,Clair和David。

从技术上将,这意味着,Alice创建了一个Git的远程节点,而对于Bob,该节点指向了Bob的版本库,反之亦然。

主分支

在核心部分,研发模型很大程度上靠其他现有模型支撑的。中心库有2个可一直延续的分支:

  • master分支
  • develop分支

每个Git用户都要熟悉原始的master分支。与master分支并行的另一个分支,我们称之为develop分支。

我们把原始库/master库认作为主分支,HEAD的源代码存在于此版本中,并且随时都是一个_预备__生产_状态。

我们把origin/develop库认为是主分支,该分支HEAD源码始终体现下个发布版的最新软件变更。有人称这个为“集成分支”,而这是每晚自动构建得来的。

当develop分支的源码到达了一个稳定状态待发布,所有的代码变更需要以某种方式合并到master分支,然后标记一个版本号。如何操作将在稍后详细介绍。

所以,每次变更都合并到了master,这就是新产品的定义。在这一点,我们倾向于严格执行这一点,从而,理论上,每当对master有一个提交操作,我们就可以使用Git钩子脚本来自动构建并且发布软件到生产服务器。

辅助性分支

我们的开发模型使用了各种辅助性分支,这些分支与关键分支(master和develop)一起,用来支持团队成员们并行开发,使得易于追踪功能,协助生产发布环境准备,以及快速修复实时在线问题。与关键分支不同,这些分支总是有一个有限的生命期,因为他们最终会被移除。

我们用到的分支类型包括:

  • 热修复分支

每一种分支有一个特定目的,并且受限于严格到规则,比如:可以用哪些分支作为源分支,哪些分支能作为合并目标。我们马上将进行演练。

从技术角度来看,这些分支绝不是特殊分支。分支的类型基于我们使用的方法来进行分类。它们理所当然是普通的Git分支。

可能是develop分支的分支版本,最终必须合并到develop分支中。

分支命名规则:除了master、develop、release-、orhotfix-之外,其他命名均可。

功能分支(有时被称为topic分支)通常为即将发布或者未来发布版开发新的功能。当新功能开始研发,包含该功能的发布版本在这个还是无法确定发布时间的。功能版本的实质是只要这个功能处于开发状态它就会存在,但是最终会或合并到develop分支(确定将新功能添加到不久的发布版中)或取消(譬如一次令人失望的测试)。

功能分支通常存在于开发者的软件库,而不是在源代码库中。

创建一个功能分支

开始一项功能的开发工作时,基于develop创建分支。

<table><tbody><tr><td>1</td><td>$ git checkout -b myfeature develop</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to a new branch"myfeature"</td></tr></tbody></table>

合并一个功能到develop分支

完成的功能可以合并进develop分支,以明确加入到未来的发布:

<table><tbody><tr><td>1</td><td>$ git checkout develop</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to branch'develop'</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ git merge --no-ff myfeature</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Updating ea1b82a..05e9557</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>(Summary of changes)</td></tr></tbody></table>

<table><tbody><tr><td>6</td><td>$ git branch -d myfeature</td></tr></tbody></table>

<table><tbody><tr><td>7</td><td>Deleted branch myfeature (was 05e9557).</td></tr></tbody></table>

<table><tbody><tr><td>8</td><td>$ git push origin develop</td></tr></tbody></table>

--no-ff标志导致合并操作创建一个新commit对象,即使该合并操作可以fast-forward。这避免了丢失这个功能分支存在的历史信息,将该功能的所有提交组合在一起。 比较:

后一种情况,不可能从Git历史中看到哪些提交一起实现了一个功能——你必须手工阅读全部的日志信息。如果对整个功能进行回退 (比如一组提交),后一种方式会是一种真正头痛的问题,而使用--no-ffflag的情况则很容易.

是的,它会创建一个新的(空)提交对象,但是收益远大于开销。

不幸的是,我还没找到一种方法,让--no-ff时作为合并操作的默认选项,但它应该是可行的。

Release 分支

Release分支可能从develop分支分离而来,但是一定要合并到develop和master分支上,它的习惯命名方式为:release-*。

Release分支是为新产品的发布做准备的。它允许我们在最后时刻做一些细小的修改。他们允许小bugs的修改和准备发布元数据(版本号,开发时间等等)。当在Release分支完成这些所有工作以后,对于下一次打的发布,develop分支接收features会更加明确。

从develop分支创建新的Release分支的关键时刻是develop分支达到了发布的理想状态。至少所有这次要发布的features必须在这个点及时合并到develop分支。对于所有未来准备发布的features必须等到Release分支创建以后再合并。

在Release分支创建的时候要为即将发行版本分配一个版本号,一点都不早。直到那时,develop分支反映的变化都是为了下一个发行版,但是在Release分支创建之前,下一个发行版到底叫0.3还是1.0是不明确的。这个决定是在Release分支创建时根据项目在版本号上的规则制定的。

创建一个release分支

Release分支是从develop分支创建的。例如,当前产品的发行版本号为1.1.5,同事我们有一个大的版本即将发行。develop 分支已经为下次发行做好了准备,我们得决定下一个版本是1.2(而不是1.1.6或者2.0)。所以我们将Release分支分离出来,给一个能够反映新版本号的分支名。

<table><tbody><tr><td>1</td><td>$ git checkout -b release-1.2 develop</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to a new branch"release-1.2"</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ ./bump-version.sh 1.2</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Files modified successfully, version bumped to 1.2.</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>$ git commit -a -m"Bumped version number to 1.2"</td></tr></tbody></table>

<table><tbody><tr><td>6</td><td>[release-1.2 74d9424] Bumped version number to 1.2</td></tr></tbody></table>

<table><tbody><tr><td>7</td><td>1 files changed, 1 insertions(+), 1 deletions(-)</td></tr></tbody></table>

创建新分支以后,切换到该分支,添加版本号。这里,bump-version.sh 是一个虚构的shell脚本,它可以复制一些文件来反映新的版本(这当然可以手动改变--目的就是修改一些文件)。然后版本号被提交。

这个新分支可能会存在一段时间,直到该发行版到达它的预定目标。在此期间,bug的修复可能被提交到该分支上(而不是提交到develop分支上)。在这里严格禁止增加大的新features。他们必须合并到develop分支上,然后等待下一次大的发行版。

完成一个****release分支

当一个release分支准备好成为一个真正的发行版的时候,有一些工作必须完成。首先,release分支要合并到master上(因为每一次提交到master上的都是一个新定义的发行版,记住)。然后,提交到master上必须打一个标签,以便以后更加方便的引用这个历史版本。最后,在release分支上的修改必须合并到develop分支上,以便未来发行版也包含这些bugs的修复。

在Git中的前两步是:

<table><tbody><tr><td>1</td><td>$ git checkout master</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to branch'master'</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ git merge --no-ff release-1.2</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Merge made by recursive.</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>(Summary of changes)</td></tr></tbody></table>

<table><tbody><tr><td>6</td><td>$ git tag -a 1.2</td></tr></tbody></table>

发行版现在已经完成,为以后引用打上标签。

编辑:你可能也想使用the-sor-u <key>flags来标记你的标签。

为了是修改保持在release分支上,我们需要合并这些到develop分支上去,在Git上:

<table><tbody><tr><td>1</td><td>$ git checkout develop</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to branch'develop'</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ git merge --no-ff release-1.2</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Merge made by recursive.</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>(Summary of changes)</td></tr></tbody></table>

这个步骤可能会导致合并冲突(可能由于改变版本号更是如此)。如果是这样,修复它然后提交。

现在我们真正的完成了,这个release分支将被删除,因为我们不再需要它了。

<table><tbody><tr><td>1</td><td>$ git branch -d release-1.2</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Deleted branch release-1.2 (was ff452fe).</td></tr></tbody></table>

热修复分支

可以基于master分支,必须合并回develop和master分支。
分支名约定:hotfix-*

热修复分支与发布分支很相似,他们都为新的生成环境发布做准备,尽管这是未经计划的。他们来自生产环境的处于异常状态压力。当生成环境验证缺陷必须马上修复是,热修复分支可以基于master分支上对应与线上版本的tag创建。

其本质是团队成员(在develop分支上)的工作可以继续,而另一个人准备生产环境的快速修复。

创建****修补bug分支

hotfix branch(修补bug分支)是从Master分支上面分出来的。例如,1.2版本是当前生产环境的版本并且有bug。但是开发分支(develop)变化还不稳定。我们需要分出来一个修补bug分支(hotfix branch)来解决这种情况。

<table><tbody><tr><td>1</td><td>$ git checkout -b hotfix-1.2.1 master</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to a new branch"hotfix-1.2.1"</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ ./bump-version.sh 1.2.1</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Files modified successfully, version bumped to 1.2.1.</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>$ git commit -a -m"Bumped version number to 1.2.1"</td></tr></tbody></table>

<table><tbody><tr><td>6</td><td>[hotfix-1.2.1 41e61bb] Bumped version number to 1.2.1</td></tr></tbody></table>

<table><tbody><tr><td>7</td><td>1 files changed, 1 insertions(+), 1 deletions(-)</td></tr></tbody></table>

分支关闭的时侯不要忘了更新版本号(bump the version)

然后,修复bug,一次提交或者多次分开提交。

<table><tbody><tr><td>1</td><td>$ git commit -m"Fixed severe production problem"</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>[hotfix-1.2.1 abbe5d6] Fixed severe production problem</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>5 files changed, 32 insertions(+), 17 deletions(-)</td></tr></tbody></table>

完成一个hotfix分支

完成一个bugfix之后,需要把butfix合并到master和develop分支去,这样就可以保证修复的这个bug也包含到下一个发行版中。这一点和完成release分支很相似。

首先,更新master并对release打上tag:

<table><tbody><tr><td>1</td><td>$ git checkout master</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to branch'master'</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ git merge --no-ff hotfix-1.2.1</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Merge made by recursive.</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>(Summary of changes)</td></tr></tbody></table>

<table><tbody><tr><td>6</td><td>$ git tag -a 1.2.1</td></tr></tbody></table>

编辑:你可能也会想使用 -sor-u <key>参数来对你的tag进行加密

下一步,把bugfix添加到develop分支中:

<table><tbody><tr><td>1</td><td>$ git checkout develop</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Switched to branch'develop'</td></tr></tbody></table>

<table><tbody><tr><td>3</td><td>$ git merge --no-ff hotfix-1.2.1</td></tr></tbody></table>

<table><tbody><tr><td>4</td><td>Merge made by recursive.</td></tr></tbody></table>

<table><tbody><tr><td>5</td><td>(Summary of changes)</td></tr></tbody></table>

规则的一个例外是: 如果一个release分支已经存在,那么应该把hotfix合并到这个release分支,而不是合并到develop分支。当release分支完成后, 将bugfix分支合并回release分支也会使得bugfix被合并到develop分支。(如果在develop分支的工作急需这个bugfix,等不到release分支的完成,那你也可以把bugfix合并到develop分支)

最后,删除临时分支:

<table><tbody><tr><td>1</td><td>$ git branch -d hotfix-1.2.1</td></tr></tbody></table>

<table><tbody><tr><td>2</td><td>Deleted branch hotfix-1.2.1 (was abbe5d6).</td></tr></tbody></table>

尽管这个分支模型没有任何震撼的新东西, 文章开头的图表在我们的项目中表现出惊人的实用性。它形成了一个优雅的思维模型,易于领悟并使团队成员发展出对分支和发布过程的共同理解。

这里提供一份高质量PDF格式图表。去吧,把它挂载墙上以便能随时快速参考。

更新: 如果有人需要: 这是主图表的gitflow-model.src.key (Apple Keynote格式).

Git-branching-model.pdf