Github仓库管理员的代码review(代码评审)与代码merge(合并)操作

-- Github仓库管理员的代码review与合并操作教程
【官网】:https://github.com

应用场景

作为技术管理或者项目经理,少不了要进行git代码的最终review和合并处理。这里就进行相关的讲解。

基础资源

github或者自己待见的github后台  (其实gitlab也大同小异,只是部分名词不一样)

使用须知

注意github的安全操作,避免在公司登陆个人的github账号,也要做好各用户权限的控制。并真正做好review等相关处理。

配置步骤


【github上pull request和gitlab上的merge request有区别吗】

没有区别,只是看待同一个问题的角度不一样而已.



  • GitHub、Bitbucket 和码云(Gitee.com)选择 Pull Request 作为这项功能的名称
  • GitLab 和 Gitorious 选择 Merge Request 作为这项功能的名称



【git merge的三种操作merge, squash merge, 和rebase merge】

举例来说:
假设在master分支的B点拉出一个新的分支dev,经过一段时间开发后:

  • master分支上有两个新的提交M1和M2
  • dev分支上有三个提交D1,D2,和D3

如下图所示:


现在我们完成了dev分支的开发测试工作,需要把dev分支合并回master分支。

  1. merge

这是最基本的merge,就是把提交历史原封不动的拷贝过来,包含完整的提交历史记录。

$ git checkout master
$ git merge dev 

image.png

此时还会生产一个merge commit (D4‘),这个merge commit不包含任何代码改动,而包含在dev分支上的几个commit列表(D1, D2和D3)。查看git的提交历史(git log)可以看到所有的这些提交历史记录。

  1. squash merge:

根据字面意思,这个操作完成的是压缩的提交;解决的是什么问题呢,由于在dev分支上执行的是开发工作,有一些很小的提交,或者是纠正前面的错误的提交,对于这类提交对整个工程来说不需要单独显示出来一次提交,不然导致项目的提交历史过于复杂;所以基于这种原因,我们可以把dev上的所有提交都合并成一个提交;然后提交到主干。

$ git checkout master
$ git merge --squash dev 


在这个例子中,我们把D1,D2和D3的改动合并成了一个D。

注意,squash merge并不会替你产生提交,它只是把所有的改动合并,然后放在本地文件,需要你再次手动执行git commit操作;此时又要注意了,因为你要你手动commit,也就是说这个commit是你产生的,不是有原来dev分支上的开发人员产生的,提交者本身发生了变化。也可以这么理解,就是你把dev分支上的所有代码改动一次性porting到master分支上而已。

  1. rebase merge

由于squash merge会变更提交者作者信息,这是一个很大的问题,后期问题追溯不好处理(当然也可以由分支dev的所有者来执行squash merge操作,以解决部分问题),rebase merge可以保留提交的作者信息,同时可以合并commit历史,完美的解决了上面的问题。

$ git checkout dev
$ git rebase -i master
$ git checkout master
$ git merge dev 

rebase merge分两步完成:
第一步:执行rebase操作,结果是看起来dev分支是从M2拉出来的,而不是从B拉出来的,然后使用-i参数手动调整commit历史,是否合并如何合并。例如下rebase -i命令会弹出文本编辑框:

pickMessage for commit #1
pickMessage for commit #2
pickMessage for commit #3 

假设D2是对D1的一个拼写错误修正,因此可以不需要显式的指出来,我们把D2修改为fixup:

pickMessage for commit #1
fixupMessage for commit #2
pickMessage for commit #3 

rebase之后的状态变为:




D1‘是D1和D2的合并。

第二步:再执行merge操作,把dev分支合并到master分支:



注意:在执行rebase的时候可能会出现冲突的问题,此时需要手工解决冲突的问题,然后执行(git add)命令;所有冲突解决完之后,这时不需要执行(git commit)命令,而是运行(git rebase --continue)命令,一直到rebase完成;如果中途想放弃rebase操作,可以运行(git rebase --abort)命令回到rebase之前的状态。





常见问题

快速入门

一个review和合并示例

【添加一个合并请求】



【对一个合并请求进行review,并且添加备注】


【对一个合并请求进行合并】



参考资料