本帖最后由 陈小宝 于 2020-6-16 17:24 编辑 1 @" ~; `8 m6 R
6 [3 ]. g9 M: i0 o& G: A4 b u
" d7 L- F( Q1 r" B3 v$ u8 v& P: h- L5 S: v
Git 作为一个源码管理系统,不可避免涉及到多人协作。
0 D, k" [! Z( S, G4 T协作必须有一个规范的工作流程,让大家有效地合作,使得项目井井有条地发展下去。”工作流程”在英语里,叫做”workflow”或者”flow”,原意是水流,比喻项目像水流那样,顺畅、自然地向前流动,不会发生冲击、对撞、甚至漩涡。 本文介绍三种广泛使用的工作流程:- Git flow
- Github flow
- Gitlab flow( g* ]/ g4 Q! q- A
一、功能驱动本文的三种工作流程,有一个共同点:都采用”功能驱动式开发”(Feature-driven development,简称FDD)。它指的是,需求是开发的起点,先有需求再有功能分支(feature branch)或者补丁分支(hotfix branch)。完成开发后,该分支就合并到主分支,然后被删除。二、Git flow最早诞生、并得到广泛采用的一种工作流程,就是Git flow 。 2.1 特点它最主要的特点有两个。 " q/ Q+ K; w! V9 \- G/ K: o
首先,项目存在两个长期分支。 主分支master 开发分支develop
: c. F# Q/ ~5 c- K7 y2 B( G4 w
前者用于存放对外发布的版本,任何时候在这个分支拿到的,都是稳定的分布版;后者用于日常开发,存放最新的开发版。 其次,项目存在三种短期分支。 功能分支(feature branch) 补丁分支(hotfix branch) 预发分支(release branch)
, e) h+ C! u1 B
一旦完成开发,它们就会被合并进develop或master,然后被删除。 Git flow 的详细介绍,请阅读我翻译的中文版《Git 分支管理策略》。 8 d' f: x0 U$ t! l2 k5 a( J2 e) ~
. |+ [& k5 i' g/ K& G 2.2 评价Git flow的优点是清晰可控,缺点是相对复杂,需要同时维护两个长期分支。大多数工具都将master当作默认分支,可是开发是在develop分支进行的,这导致经常要切换分支,非常烦人。 ( N$ h& U- P) Y% b- @2 h. i! u- v
更大问题在于,这个模式是基于”版本发布”的,目标是一段时间以后产出一个新版本。但是,很多网站项目是”持续发布”,代码一有变动,就部署一次。这时,master分支和develop分支的差别不大,没必要维护两个长期分支。 # r7 |8 R! m& T
+ h8 v. @ H0 k6 i! e 三、Github flowGithub flow 是Git flow的简化版,专门配合”持续发布”。它是 Github.com 使用的工作流程。 3.1 流程它只有一个长期分支,就是master,因此用起来非常简单。 官方推荐的流程如下。 $ p: ?" ~+ D; M
% i9 {" r% w/ r4 N1 C: b
第一步:根据需求,从master拉出新分支,不区分功能分支或补丁分支。 第二步:新分支开发完成后,或者需要讨论的时候,就向master发起一个pull request(简称PR)。 第三步:Pull Request既是一个通知,让别人注意到你的请求,又是一种对话机制,大家一起评审和讨论你的代码。对话过程中,你还可以不断提交代码。 第四步:你的Pull Request被接受,合并进master,重新部署后,原来你拉出来的那个分支就被删除。(先部署再合并也可。)
- v- M- A( G- G2 U 3.2 评价Github flow 的最大优点就是简单,对于”持续发布”的产品,可以说是最合适的流程。
8 p( f+ ]. Y! K% M
问题在于它的假设:master分支的更新与产品的发布是一致的。也就是说,master分支的最新代码,默认就是当前的线上代码。
/ p! b: k- p, z4 v' M& y8 ?* x可是,有些时候并非如此,代码合并进入master分支,并不代表它就能立刻发布。比如,苹果商店的APP提交审核以后,等一段时间才能上架。这时,如果还有新的代码提交,master分支就会与刚发布的版本不一致。另一个例子是,有些公司有发布窗口,只有指定时间才能发布,这也会导致线上版本落后于master分支。
% _- Z* n* A& u5 w: T; G5 p" V上面这种情况,只有master一个主分支就不够用了。通常,你不得不在master分支以外,另外新建一个production分支跟踪线上版本。
# c! f7 a# A3 l# P1 e# S" Q2 x0 H8 ^2 {! c; ?4 m
四、Gitlab flowGitlab flow 是 Git flow 与 Github flow 的综合。它吸取了两者的优点,既有适应不同开发环境的弹性,又有单一主分支的简单和便利。它是 Gitlab.com 推荐的做法。
4 Y. N q# N1 h G5 `4.1 上游优先Gitlab flow 的最大原则叫做”上游优先”(upsteam first),即只存在一个主分支master,它是所有其他分支的”上游”。只有上游分支采纳的代码变化,才能应用到其他分支。 Chromium项目就是一个例子,它明确规定,上游分支依次为: Linus Torvalds的分支 子系统(比如netdev)的分支 设备厂商(比如三星)的分支 6 A/ D. M# |4 u O* A+ G
4.2 持续发布Gitlab flow 分成两种情况,适应不同的开发流程。 对于”持续发布”的项目,它建议在master分支以外,再建立不同的环境分支。比如,”开发环境”的分支是master,”预发环境”的分支是pre-production,”生产环境”的分支是production。
! [0 d6 l) t3 H# v! @
开发分支是预发分支的”上游”,预发分支又是生产分支的”上游”。代码的变化,必须由”上游”向”下游”发展。比如,生产环境出现了bug,这时就要新建一个功能分支,先把它合并到master,确认没有问题,再cherry-pick到pre-production,这一步也没有问题,才进入production。 $ ^2 M" @0 G7 W6 A6 I$ L% ?
只有紧急情况,才允许跳过上游,直接合并到下游分支。
' Q2 [: f2 N2 g+ \( {$ m( m4.3 版本发布& |+ l* K/ p+ h
对于”版本发布”的项目,建议的做法是每一个稳定版本,都要从master分支拉出一个分支,比如2-3-stable、2-4-stable等等。 以后,只有修补bug,才允许将代码合并到这些分支,并且此时要更新小版本号。 5 U1 I5 Y0 S+ k- V& X: I7 f
五、一些小技巧
! b; Z4 g) X' z' C* i" T2 R: w/ `9 P# I7 s" Z- P |
5.1 Pull Request
5 ~% M. o5 P- U! v+ c3 t1 H
" V, y) C$ `1 N6 S
功能分支合并进master分支,必须通过Pull Request(Gitlab里面叫做 Merge Request)。 X1 V& N, d: _7 O) e* U
前面说过,Pull Request本质是一种对话机制,你可以在提交的时候,@相关人员或团队,引起他们的注意。
/ R: A& @4 b r- }( |5 E4 `2 U5.2 Protected branch
* e Z/ q8 Q8 i+ F
9 ?) _' ^% p+ `7 K2 T5 `master分支应该受到保护,不是每个人都可以修改这个分支,以及拥有审批 Pull Request 的权力。 , B4 o1 E* G! J+ f, [
Github 和 Gitlab 都提供”保护分支”(Protected branch)这个功能。 ' A3 s5 ]& W0 O2 n$ ]+ @- J
5.3 Issue0 H& Z6 {+ [/ M* m* F
6 i4 ^8 \/ p& g% W& A/ B
Issue 用于 Bug追踪和需求管理。建议先新建 Issue,再新建对应的功能分支。功能分支总是为了解决一个或多个 Issue。 功能分支的名称,可以与issue的名字保持一致,并且以issue的编号起首,比如”15-require-a-password-to-change-it”。
) e l; W7 j( [- l$ r* p) D
开发完成后,在提交说明里面,可以写上”fixes #14”或者”closes #67”。Github规定,只要commit message里面有下面这些动词 + 编号,就会关闭对应的issue。
, ~* E+ Z1 G k6 ?' `% ~* Eclose closes closed fix fixes fixed resolve resolves resolved + ^5 v- f. t f0 e6 G3 Q- k0 W. O' F
这种方式还可以一次关闭多个issue,或者关闭其他代码库的issue,格式是username/repository#issue_number。
. O$ P4 l1 n+ x6 {& UPull Request 被接受以后,issue关闭,原始分支就应该删除。如果以后该issue重新打开,新分支可以复用原来的名字。
' K2 W0 A3 n/ v$ ~; m5.4 Merge节点
- Q% Y' j/ Q: [. W* r6 J& H
Git有两种合并:一种是”直进式合并”(fast forward),不生成单独的合并节点;另一种是”非直进式合并”(none fast-forword),会生成单独节点。 5 c' U. {4 b; [+ _" x
前者不利于保持commit信息的清晰,也不利于以后的回滚,建议总是采用后者(即使用—no-ff参数)。只要发生合并,就要有一个单独的合并节点。 5.5 Squash 多个commit
9 B1 `2 P0 Y: V/ i# ~+ [) |4 t
为了便于他人阅读你的提交,也便于cherry-pick或撤销代码变化,在发起Pull Request之前,应该把多个commit合并成一个。(前提是,该分支只有你一个人开发,且没有跟master合并过。)
, d) F1 X' n3 e- |0 x4 P
+ R; g3 q3 [$ p2 n, _* M1 q* \& d
这可以采用rebase命令附带的squash操作,具体方法请参考我写的《Git 使用规范流程》。 ) O0 s4 v/ {1 O& E6 A* P: _3 v0 c- X
来源:http://www.ruanyifeng.com/blog/2 ... ?bsh_bid=2219775734 |