一、基本概念
1. 仓库(Repository)
① 源仓库(线上版本库)
在项目的开始,项目的发起者构建起一个项目的最原始的仓库,称为origin。
源仓库的有两个作用:
-
汇总参与该项目的各个开发者的代码
-
存放趋于稳定和可发布的代码
源仓库应该是受保护的,开发者不应该直接对其进行开发工作。只有项目管理者能对其进行较高权限的操作。
② 开发者仓库(本地仓库)
任何开发者都不会对源仓库进行直接的操作,源仓库建立以后,每个开发者需要做的事情就是把源仓库的“复制”一份,作为自己日常开发的仓库。这个复制是gitlab上面的fork。
每个开发者所fork的仓库是完全独立的,互不干扰,甚至与源仓库都无关。每个开发者仓库相当于一个源仓库实体的影像,开发者在这个影像中进行编码,提交到自己的仓库中,这样就可以轻易地实现团队成员之间的并行开发工作。而开发工作完成以后,开发者可以向源仓库
发送pull request,请求管理员把自己的代码合并到源仓库中,这样就实现了分布式开发工作和集中式的管理。
2. 分支(Branch)
① master branch:主分支
master:主分支从项目一开始便存在,它用于存放经过测试,已经完全稳定代码;在项目开发以后的任何时刻当中,master存放的代码应该是可作为产品供用户使用的代码。所以,应该随时保持master仓库代码的清洁和稳定,确保入库之前是通过完全测试和代码reivew
的。master分支是所有分支中最不活跃的,大概每个月或每两个月更新一次,每一次master更新的时候都应该用git打上tag,来说明产品有新版本发布。
② develop branch:开发分支
develop:开发分支,一开始从master分支中分离出来,用于开发者存放基本稳定代码。每个开发者的仓库相当于源仓库的一个镜像,每个开发者自己的仓库上也有master和develop。开发者把功能做好以后,是存放到自己的develop中,当测试完以后,可以向管理者
发起一个pull request,请求把自己仓库的develop分支合并到源仓库的develop中。所有开发者开发好的功能会在源仓库的develop分支中进行汇总,当develop中的代码经过不断的测试,已经逐渐趋于稳定了,接近产品目标了。这时候,就可以把develop分支合并
到master分支中,发布一个新版本。
注:任何人不应该向master直接进行无意义的合并、提交操作。正常情况下,master只应该接受develop的合并,也就是说,master所有代码更新应该源于合并develop的代码。
③ feature branch:功能分支
feature:功能性分支,是用于开发项目的功能的分支,是开发者主要战斗阵地。开发者在本地仓库从develop分支分出功能分支,在该分支上进行功能的开发,开发完成以后再合并到develop分支上,这时候功能性分支已经完成任务,可以删除。功能性分支的命名一般
为feature-*,*为需要开发的功能的名称。
二、如何操作(仅做举例说明用)
Step 1:源仓库的构建
这一步通常由项目发起人(项目管理员)来操作,源仓库为op/Chanj_Asset_Management,并初始化两个分支master和develop.
Step 2:开发者fork源仓库
源仓库建立以后,每个开发就可以去复制一份源仓库到自己的gitlab账号中,然后作为自己开发所用的仓库。假设我是一个项目中的开发者,我就到op/Chanj_Asset_Managemen项目主页上去fork.
Step 3:把自己开发者仓库clone到本地
>>> git clone http://gitlab.rd.chanj.com/op/Chanj_Asset_Management.git
Step 4:构建功能分支进行开发
假设现在要开发一个“讨论”功能:
>>> git checkout develop
# 切换到`develop`分支
>>> git checkout -b feature-discuss
# 分出一个功能性分支
>>> touch discuss.py
# 假装discuss.py就是我们要开发的功能
>>> git add .
>>> git commit -m 'finish discuss feature'
# 提交更改,多次测试以后
>>> git checkout develop
# 回到develop分支
>>> git merge --no-ff feature-discuss
# 把做好的功能合并到develop中
>>> git branch -d feature-discuss
# 删除功能性分支
>>> git push origin develop
# 把develop提交到自己的远程仓库中
此时,上自己gitlab的项目主页中develop分支中查看,已经有discuss.py这个文件了:
Step 5:向管理员提交pull request
在完成了“讨论”功能(当然,也可能对自己的develop进行了多次合并,完成了多个功能),经过测试以后,觉得没问题,就可以请求管理员把自己仓库的develop分支合并到源仓库的develop分支中。
Step 6:管理员测试、合并
管理员登陆gitlab,看到了开发者对源仓库发起的pull request。
管理员需要做的事情就是:
1.对开发者的代码进行review。
2.在他的本地测试新建一个测试分支,测试开发者的代码:
>>> git checkout develop
进入管理员本地的develop分支
>>> git checkout -b manager-develop
从develop分支中分出一个叫manager-develop的测试分支测试开发者的代码
>>> git pull http://gitlab.rd.chanj.com/op/Chanj_Asset_Management.git develop
把开发者的代码pull到测试分支中,进行测试
判断是否同意合并到源仓库的develop中,如果经过测试没问题,可以把开发者的代码合并到源仓库的develop中:
>>> git checkout develop
>>> git merge --no-ff manager-develop
>>> git push origin develop
注:管理员一直在操作的仓库是源仓库。
以上,就是一个git和gitlab协同工作流的基本步骤。