git-cherry-pick之使用心得

版权声明：本文为神州灵云作者的原创文章，未经神州灵云允许不得转载。

本文作者：Spike

笔者开发的项目，为了保持一个相对简单的提交记录，合并代码是一直是使用git rebase.

后来要出版本，于是建立了版本分支，每次合并代码后会提交一个版本号。

类似于以下记录:

a - b - c - d - e (dev) \ - version1 (v1.0) 

后来又开发了几个功能，在dev分支上又提交了b,c,d等几个commit，现在要把他们合并到v1.0分支上

合并完后，提交记录应该是这样的：

a - b - c - d - e (dev) \ - version1 - b' - c' - d' - e' - version2 (v1.0) 

但是，用git rebase后，记录会变成这样:

a - b - c - d - e (dev) \ - b' - c' - d' - e' - version1' - version2 (v1.0) 

version1应该在b之前的，但由于git rebase的关系，会被移动到后面。

为了解决这个问题，看了看git的文档，发现cherry-pick正好能解决这个问题。

什么是cherry-pick

git cherry-pick，可以把已存在的commit摘出来，应用到任意分支上去。

a - b - c - d (master) \ e - f (feature) 

例如，希望只把feature分支上的提交e，应用到master上。

通过cherry-pick，就能得到这样的记录：

a - b - c - d - e` (master) \ e - f (feature) 

什么时候用cherry-pick

当你只想应用分支上的某个或多个commit，而不想那条分支上所有commit都拿过来的时候，你就可能用的上cherry-pick.

一些应用场景

• 不小心把一个commit，提交在错误的分支上了，可以用cherry-pick把这个提交摘出，再放回到正确的分支上。

• 在一条功能上开发时，发现了一个明显的bug，你修复了它并作为独立的bug提交了，这个时候你还不想合并你的功能分支，但可以用cherry-pick把这个bug先应用到主分支上，避免更多人遇到这个bug。

• …

如何使用cherry-pick

pick一个提交

git cherry-pick <commit>

步骤：

• ++通过git log，找到你要pick的提交的commit hash，记住它++

liangyanleis-MacBook-Pro:mail-for-yun spike$ git lg * 58cad8f - (HEAD -> master) 提交三 (2 minutes ago) <Spike> * 34d80e2 - 提交二 (4 minutes ago) <Spike> * 31cb504 - 提交一 (5 minutes ago) <Spike> * 9b90c3b - (origin/master, pick) refactor: change count to yun's birthday (5 weeks ago) <Spike> 

可以看到，master和pick分支，都有9b90c3b这个commit

在master上，又提交了三个commit（提交一，提交二，提交三）

假设，要把提交一(31cb504)应用到pick分支上

• ++切换到你要应用的分支++

liangyanleis-MacBook-Pro:mail-for-yun spike$ git checkout pick Switched to branch 'pick' liangyanleis-MacBook-Pro:mail-for-yun spike$ git lg * 9b90c3b - (HEAD -> pick, origin/master) refactor: change count to yun's birthday (5 weeks ago) <Spike> 

• ++执行cherry-pick++

liangyanleis-MacBook-Pro:mail-for-yun spike$ git cherry-pick 31cb504 [pick 1d3aaab] 提交一 Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:02 2019 +0800 1 file changed, 1 insertion(+) create mode 100644 demo.js liangyanleis-MacBook-Pro:mail-for-yun spike$ git lg * 1d3aaab - (HEAD -> pick) 提交一 (15 seconds ago) <Spike> * 9b90c3b - (origin/master) refactor: change count to yun's birthday (5 weeks ago) <Spike> 

这样，就把master分支上的提交一应用到pick分支上了

pick多个提交

pick多个提交只要多写几个commit hash就可以了

例如，把master上的提交一(31cb504)和提交二(34d80e2)都放到pick分支上。

步骤：

• ++切换到pick分支++

liangyanleis-MacBook-Pro:mail-for-yun spike$ git checkout pick Switched to branch 'pick' liangyanleis-MacBook-Pro:mail-for-yun spike$ git lg * 9b90c3b - (HEAD -> pick, origin/master) refactor: change count to yun's birthday (5 weeks ago) <Spike> 

• ++执行cherry-pick，把提交一和提交二拿过来++

liangyanleis-MacBook-Pro:mail-for-yun spike$ git cherry-pick 31cb504 34d80e2 [pick a148d87] 提交一 Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:02 2019 +0800 1 file changed, 1 insertion(+) create mode 100644 demo.js [pick fce8a6b] 提交二 Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:49 2019 +0800 1 file changed, 1 insertion(+), 1 deletion(-) liangyanleis-MacBook-Pro:mail-for-yun spike$ git lg * fce8a6b - (HEAD -> pick) 提交二 (5 seconds ago) <Spike> * a148d87 - 提交一 (5 seconds ago) <Spike> * 9b90c3b - (origin/master) refactor: change count to yun's birthday (5 weeks ago) <Spike> 

不管要pick多少个commit，只要一个个写上去就好了。

对于非连续的commit，这样算是比较方便的。

不过对于连续的commit，还有更方便的方法。

指定cherry-pick的范围

本例中，提交一和提交二是连在一起的, 可以看看master分支的记录：

liangyanleis-MacBook-Pro:mail-for-yun spike$ git lg * 58cad8f - (HEAD -> master) 提交三 (24 hours ago) <Spike> * 34d80e2 - 提交二 (24 hours ago) <Spike> * 31cb504 - 提交一 (24 hours ago) <Spike> * 9b90c3b - (origin/master, pick) refactor: change count to yun's birthday (5 weeks ago) <Spike> * 1fc7215 - refactor: open schedule (7 weeks ago) <Spike> 

对于连续的commit，可以通过指定一个范围，然后cherry-pick这个范围里的commit。

例如，想要cherry-pick提交一提交二，可以这么写：

liangyanleis-MacBook-Pro:mail-for-yun spike$ git cherry-pick 9b90c3b..34d80e2 [pick ad0c3b8] 提交一 Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:02 2019 +0800 1 file changed, 1 insertion(+) create mode 100644 demo.js [pick ecdcae4] 提交二 Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:49 2019 +0800 1 file changed, 1 insertion(+), 1 deletion(-) 

9b90c3b..34d80e2 表示从9b90c3b开始到34d80e2结束，但***不包括***9b90c3b这个范围的提交， 即提交一(31cb504), 提交二(34d80e2)

更多的范围选择方法，可以参考Git - gitrevisions Documentation.

处理冲突

cherry-pick时，可能会遇到冲突，cherry-pick提供了三个命令：

• git cherry-pick --continue
  • 解决完冲突，继续执行停下来的cherry-pick
• git cherry-pick --abort
  • 放弃这次cherry-pick，回到执行cherry-pick之前的状态
• git cherry-pick --quit
  • 退出cherry-pick，但是已经完成的cherry-pick还会保留下来。
  • 例如你cherry-pick了4个commit，执行到第5个时有冲突停住了，你不想要第五个，但又想保留之前的4个，那么--quit就可以实现。

一些选项

-e

–edit

允许你在cherry-pick的时候去编辑每个commit的提交信息

-n

–no-commit

cherry-pick默认会在当前分支上创建一系列的commit。如果加入这个参数，就不会创建commit，而只是把改变放到工作区和缓存区中。

-x

加上这个参数，会在commit信息中，加上一些标记，标记这个commit是从哪里cherry-pick过来的。

liangyanleis-MacBook-Pro:mail-for-yun spike$ git cherry-pick -x 31cb504 [pick 07aed85] 提交一 Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:02 2019 +0800 1 file changed, 1 insertion(+) create mode 100644 demo.js liangyanleis-MacBook-Pro:mail-for-yun spike$ git show 07aed85 commit 07aed85558e4da1b1c2b6620e3eb66b2529e064a (HEAD -> pick) Author: Spike <spike@liangyanleis-MacBook-Pro.local> Date: Mon Jun 3 00:46:02 2019 +0800 提交一 (cherry picked from commit 31cb5044061cf3fcf71a15166c88c05c9a4f19fa) 

参考连接

• Git - git-cherry-pick Documentation
• Git Cherry Pick | Atlassian Git Tutorial
• Git - gitrevisions Documentation
• What are the differences between double-dot “…” and triple-dot “…” in Git commit ranges?
• What’s different between --abort and --quit as sequencer subcommands for cherry-pick?