git 的操作规范

xiaoxiao2021-03-01  15

一、主分支Master

首先,代码库应该有一个、且仅有一个主分支。所有提供给用户使用的正式版本,都在这个主分支上发布。

Git主分支的名字,默认叫做Master。它是自动建立的,版本库初始化以后,默认就是在主分支在进行开发。

二、开发分支Develop

主分支只用来分布重大版本,日常开发应该在另一条分支上完成。我们把开发用的分支,叫做Develop。

这个分支可以用来生成代码的最新隔夜版本(nightly)。如果想正式对外发布,就在Master分支上,对Develop分支进行"合并"(merge)。

Git创建Develop分支的命令:

git checkout -b develop master

将Develop分支发布到Master分支的命令:

# 切换到Master分支

git checkout master

# 对Develop分支进行合并

git merge --no-ff develop

这里稍微解释一下,上一条命令的--no-ff参数是什么意思。默认情况下,Git执行"快进式合并"(fast-farward merge),会直接将Master分支指向Develop分支。

使用--no-ff参数后,会执行正常合并,在Master分支上生成一个新节点。为了保证版本演进的清晰,我们希望采用这种做法。关于合并的更多解释,请参考Benjamin Sandofsky的《Understanding the Git Workflow》。

三、临时性分支

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

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

* 功能(feature)分支

* 预发布(release)分支

* 修补bug(fixbug)分支

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

四、 功能分支

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

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

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

创建一个功能分支:

git checkout -b feature-x develop

开发完成后,将功能分支合并到develop分支:

git checkout develop

git merge --no-ff feature-x

删除feature分支:

git branch -d feature-x

五、预发布分支

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

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

创建一个预发布分支:

git checkout -b release-1.2 develop

确认没有问题后,合并到master分支:

git checkout master

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分支是从Master分支上面分出来的。修补结束以后,再合并进Master和Develop分支。它的命名,可以采用fixbug-*的形式。

创建一个修补bug分支:

git checkout -b fixbug-0.1 master

修补结束后,合并到master分支:

git checkout master

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

操作规范实例

介绍

我们采用Git-flow的分支结构和思想,中心仓库包含了两个主要分支,这两个分支的寿命是无限的:

                        master

                        develop

同时,我们会用到几个支持性分支:

                        release

                         hotfix

应用

要求:

        开发的同学不要向master分支提交代码,由负责发布的同学统一合并。

        原则上,所有需要进入develop或release的代码都需要通过pull request进行代码review,review通过后再merge。

        开发的同学,请先在github上fork仓库,切换到develop进行开发,开发完成后向中心仓库提交pull request。

        进入stablelization阶段的Sprint,由负责发布的同学创建release分支,之后仅对release进行bug-fixing。待release达到发布状态时,将release合并到master分支,并tag;同时合并到develop分支。然后finish该release分支。

版本号

版本号组成:<major>.<minor>.<hotfix>

<major>: 主版本号,该版本号的递增会比较慎重,一般意味着可能有产品设计上的重构,可能存在兼容性变化。现阶段我们使用0,等产品上线时再讨论要不要升级到1.

<minor>: 从版本号,该版本号反应功能升级,随着每个sprint进行递增。

<hotfix>: 热修复版本号,在一个版本已经发布到线上,需要进行该版本的热修复时,递增该版本号。每个Sprint的第一个版本的hotfix号为0.

开发准备

fork

首先,从中心仓库Fork一个克隆仓库到自己github下(之后建议在setting里,将默认branch设置为develop)。

clone

将fork到自己账户下的仓库clone到本地(请使用https地址);

add remote

本地终端运行如下命令,添加中心仓库的remote

$ git remote add center [中心仓库地址]

至此,所有的准备工作已经完成,你可以在fork出的仓库下,切换到develop分支进行开发了。

代码提交及更新

// add要提交的文件

$ git add xxx

// 添加描述并commit文件

$ git commit -m "develop create new class"

[vulcan eafcdd8] branch test

1 file changed, 1 deletion(-)

//更新center仓库代码到本地develop,此时如果有冲突,请本地手动解冲突,重新提交冲突文件

$ git pull center develop

// push到你的fork仓库

$ git push

Everything up-to-date

现在,你可以到github上,在你fork的仓库下,发起Pull请求了(请注意检查merge的仓库是否正确)。

转载请注明原文地址: https://www.6miu.com/read-4050232.html

最新回复(0)