GitHub Flow & Git Flow 基于Git 的两种协作开发模式
01、分支模型
- master:长期分支,一般用于管理对外发布版本,每个 commit 对一个 tag,也就是一个发布版本
- develop:长期分支,一般用于作为日常开发汇总,即开发版的代码
- feature: 短期分支,一般用于一个新功能的开发
- hotfix :短期分支 ,一般用于正式发布以后,出现 bug,需要创建一个分支,进行 bug 修补。
- release :短期分支,一般用于发布正式版本之前(即合并到 master 分支之前),需要有的预发布的版本进行测试。
master和develop作为主要分支。
新功能的开发在feature上进行,该分支从develop分支派生,功能开发完毕后merge到develop分支。 一般feature分支都存在与开发者本地,除非该分支需要多方合作才提交到远程仓库。
如何保证和develop分支的代码同步?每天从develop分支拉去最新的代码,使用rebase命令 不要使用pull,每次合并上游更改时feature 分支都会引入一个外来的合并提交,使用pull会生成一个新的合并commit。
在将其他分支的代码合并到当前分支时,如果那个分支是当前分支的父分支,为了保持图表的可读性和可追踪性,可以考虑用 git rebase 来代替 git merge;反过来或者不是父子关系的两个分支以及互相已经 git merge 过的分支,就不要采用 git rebase 了,避免出现重复的冲突和提交节点。
release分支是从develop分支派生, bug fix只在release分支上进行,该分支也是QA的测试分支,开发结束后同时合并进develop和master分支
使用merge request将release分支的提交合并master分支,并打上tag。
hotfix可以单独出一个分支,也可以直接在release分支上进行。
所有master上的代码都是从release分支合并进去的。
追踪远程develop分支
git checkout -b develop origin/develop
feature 分支操作
获取dev分支最新代码
$ git pull --rebase origin dev 或者 $ git rebase dev $ git checkout -b myfeature develop $ git checkout develop Switched to branch 'develop' $ git merge --no-ff myfeature Updating ea1b82a..05e9557 (Summary of changes) $ git branch -d myfeature Deleted branch myfeature (was 05e9557). $ git push origin develop
rebase最大的好处是你的项目历史会非常整洁。首先,它不像git merge 那样引入不必要的合并提交。其次,如上图所示,rebase导致最后的项目历史呈现出完美的线性——你可以从项目终点到起点浏览而不需要任何的Fork。这让你更容易使用git log 、git bisect 和gitk 来查看项目历史。 不过,这种简单的提交历史会带来两个后果:安全性和可跟踪性。如果你违反了Rebase黄金法则,重写项目历史可能会给你的协作工作流带来灾难性的影响。此外,rebase不会有合并提交中附带的信息——你看不到feature分支中并入了上游的哪些更改。
rebase的黄金法则
git rebase 的黄金法则便是,绝不要在公共的分支上使用它。 比如说,如果你把master分支rebase到你的feature分支上会发生什么
场景:你在feature上开发了一些功能还没有能够提交,现在有个Bug需要在develop分支上fix,怎么操作?
在feature分支上 执行 add & stash ,将当前的更新暂存起来
切换到develop分支,fix bug,commit & push(也可以不push)
切换到feature分支,rebase develop分支,发现冲突就解决冲突
最后 git stash pop ,弹出之前暂存的内容,这时也可能发生冲突,也比较好解决
这里主要就是应用了stash的功能,防止在feature上开发的功能还未能够提交,同时又有紧急的bug需要fix。
release 分支操作
# 合并到master $ git checkout master Switched to branch 'master' $ git merge --no-ff release-1.2 Merge made by recursive. (Summary of changes) $ git tag -a 1.2 # 合并到develop $ git checkout develop Switched to branch 'develop' $ git merge --no-ff release-1.2 # 删除release分支 $ git branch -d release-1.2
hotfix 分支操作
当产品发布出去之后,有紧急的bug,就需要从master分支中拉出一个hot fix分支。 这么做的好处是develop分支上的同事可以继续进行开发,另一个团队则可以在master分支上进行一个产品修复更新。 修复好之后,合并到mater分支和develop分支。
这里有一个特殊情况,如果当时的release分支还存在,那么hotfix的更新需要merge到相应的release分支上。 如果release分支已经不存在了,那么就只需要merge到master分支和develop分支。
创建远程分支
git push origin local_branch:remote_branch
local_branch必须为你本地存在的分支,remote_branch为远程分支,如果remote_branch不存在则会自动创建分支。
02、开发规范
commit规范
只要坚持做到以下几点就 OK 了:
- 提交时的粒度是一个小功能点或者一个 bug fix,这样进行恢复等的操作时能够将「误伤」减到最低;
- 用一句简练的话写在第一行,然后空一行稍微详细阐述该提交所增加或修改的地方;
- 不要每提交一次就推送一次,多积攒几个提交后一次性推送,这样可以避免在进行一次提交后发现代码中还有小错误。
谁说历史不可篡改了?前提是,想要合并的那几次提交还没有推送到远程!
Commit Message 格式
<type>(<scope>): <subject> <空行> <body> <空行> <footer>
type
- feat:新功能(feature)
- fix:修补bug
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
Scope
用来说明本次Commit影响的范围,即简要说明修改会涉及的部分。这个本来是选填项,但从AngularJS实际项目中可以看出基本上也成了必填项了。
Subject
用来简要描述本次改动,概述就好了,因为后面还会在Body里给出具体信息。并且最好遵循下面三条:
- 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
- 首字母不要大写
- 结尾不用句号(.)
Body
里的内容是对上面subject里内容的展开,在此做更加详尽的描述,内容里应该包含修改动机和修改前后的对比。
Footer
footer里的主要放置不兼容变更和Issue关闭的信息
Revert
此外如果需要撤销之前的Commit,那么本次Commit Message中必须以revert:开头,后面紧跟前面描述的Header部分,格式不变。并且,Body部分的格式也是固定的,必须要记录撤销前Commit的SHA值。
提交
推送
拉取
1. 把本地repo从上次pull之后的变更暂存起来
2. 恢复到上次pull时的情况
3. 套用远端的变更
4. 最后再套用刚暂存下来的本地变更
有冲突怎么办?
rebase跟merge类似,出现conflict会暂停rebase动作,需要你手动修复后,然后才可以继续动作。这也是rebase比merge复杂一点的地方:merge如果发生conflict,你只需要解决冲突一次,然后commit出去就完成了。而rebase的conflict可能会发生在上述步骤4的每一次重新套用上,所以可能需要解决冲突好几次。
到底什么时候用merge?什么时候用rebase?
如果你修改比较多,预期会有较多的conflict,建议用merge。(不过,如果是多次大范围的主题式修改,那是不是应该一开始就多开一个branch来做呢?)。
如果改动范围较小,不太预期有conflict,则建议可以加上rebase参数。
如果想要把 rebase 當做 git pull 的預設值,可以在專案的 .git/config 加上
[branch "master"]
remote = origin
merge = refs/heads/master
rebase = true
也可以直接加到 ~/.gitconfig 讓所有的 tracked branches 都自動套用這個設定:
[branch]
autosetuprebase = always
合并
在将其他分支的代码合并到当前分支时,如果那个分支是当前分支的父分支,为了保持图表的可读性和可追踪性,可以考虑用 git rebase 来代替 git merge;反过来或者不是父子关系的两个分支以及互相已经 git merge 过的分支,就不要采用 git rebase 了,避免出现重复的冲突和提交节点。
分支命名
除了主要分支的名字是固定的之外,派生分支是需要自己命名的,这里就要有个命名规范了。强烈推荐用如下形式:feature——按照功能点(而不是需求)命名;
release——用发布时间命名,可以加上适当的前缀;
hotfix——GitLab 的 issue 编号或 bug 性质等。
另外还有 tag,用语义化的版本号命名。
03、链接
- A successful Git branching model-重要
- 团队中的 Git 实践
- Git: 教你如何在Commit时有话可说
- Git Flow