git cherry-pick

概述

git cherry-pick可以用于将在其他分支上的 commit 修改，移植到当前的分支。例如，想在某个稳定版本上，添加一个刚开发完成的版本中的功能，就可以使用 Cherry-pick 命令，将这个功能相关的 commit 提取出来，合入稳定版本的分支上。

如何使用

git cherry-pick commit-id

注意：当执行完 cherry-pick 以后，将会生成一个新的提交；这个新的提交的哈希值和原来的不同，但标识名一样

在本地仓库中，有两个分支:branch1和branch2，我们先来查看各个分支的提交：

//切换到branch2分支
$ git checkout branch2
Switched to branch 'branch2'
//查看最近三次提交
$ git log --oneline -3
23d9422 [Description]:branch2 commit 3
2555c6e [Description]:branch2 commit 2
b82ba0f [Description]:branch2 commit 1
//切换到branch1分支
$ git checkout branch1
Switched to branch 'branch1'
//查看最近三次提交
$ git log --oneline -3
20fe2f9 commit second
c51adbe commit first
ae2bd14 commit 3th

现在，我想要将branch2分支上的第一次提交内容合入到branch1分支上，则可以使用git cherry-pick命令：

$ git cherry-pick 2555c6e
error: could not apply 2555c6e... [Description]:branch2 commit 2
hint: after resolving the conflicts, mark the corrected paths
hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'

当cherry-pick时，没有成功自动提交，这说明存在冲突，因此首先需要解决冲突,解决冲突后需要git commit手动进行提交：

$ git commit 
[branch1 790f431] [Description]:branch2 commit 2
 Date: Fri Jul 13 18:36:44 2018 +0800
 1 file changed, 1 insertion(+)
 create mode 100644 only-for-branch2.txt

或者git add .后直接使用git cherry-pick --continue继续。
现在查看提交信息：

$ git log --oneline -3
790f431 [Description]:branch2 commit 2
20fe2f9 commit second
c51adbe commit first

branch2分支上的第二次提交成功合入到了branch1分支上。

git cherry-pick -x commit_id

增加 -x 参数，表示保留原提交的作者信息进行提交。

git cherry-pick start-commit-id…end-commit-id

• 在 Git 1.7.2 版本开始，新增了支持批量 cherry-pick ，就是可以一次将一个连续的时间序列内的 commit ，设定一个开始和结束的 commit ，进行 cherry-pick 操作。
• 范围是 start-commit-id 到 end-commit-id 之间所有的 commit，但是它这是一个 (左开，右闭] 的区间，它将不会包含 start-commit-id 的 commit。

git cherry-pick start-commit-id^…end-commit-id

如果想要包含 start-commit-id 的话，就需要使用 ^ 标记一下，就会变成一个 [左闭，右闭] 的区间

使用 git log —pretty=oneline 来查看当前分支最近的提交，注意 git 命令中，对于 commit-id 的操作，都只需要使用前五位就可以了。
git cherry-pick 371c2…971209 // (2,5]
git cherry-pick 371c2^…971209 // [2,5]

git cherry-pick -n

如果不想git cherry-pick自动进行提交，则加参数-n即可。比如将branch2分支上的第三次提交内容合入到branch1分支上：

$ git cherry-pick 23d9422
[branch1 2c67715] [Description]:branch2 commit 3
 Date: Fri Jul 13 18:37:05 2018 +0800
 1 file changed, 1 insertion(+)

查看提交log,它自动合入了branch1分支：

$ git log --oneline -3
2c67715 [Description]:branch2 commit 3
f8bc5db [Description]:branch2 commit 2
20fe2f9 commit second

如果不想进行自动合入，则使用git cherry-pick -n：

//回退上次提交，再此进行cherry-pick
$ git reset --hard HEAD~
HEAD is now at f8bc5db [Description]:branch2 commit 2
$ git cherry-pick -n 23d9422
$ git status
On branch branch1
Changes to be committed:
  (use "git reset HEAD <file>..." to unstage)

    modified:   only-for-branch2.txt

这时通过git status查看，发现已将branch2的提交获取但是没有合入。

git cherry-pick -e

如果想要在cherr-pick后重新编辑提交信息，则使用git cherry-pick -e命令，比如我们还是要将branch2分支上的第三次提交内容合入到branch1分支上，但是需要修改提交信息：

$ git cherry-pick -e 23d9422
[Description]:branch2 commit 3

git cherry-pick –continue, –abort，–quit

当使用git cherry-pick发生冲突后,将会出现如下信息：

$ git cherry-pick 23d9422
error: could not apply 23d9422... [Description]:branch2 commit 3
hint: after resolving the conflicts, mark the corrected paths
hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'

这时如果要继续cherry-pick，则首先需要解决冲突，通过git add .将文件标记为已解决，然后可以使用git cherry-pick --continue命令，继续进行cherry-pick操作。

如果要中断这次cherry-pick,则使用git cherry-pick --quit，这种情况下当前分支中未冲突的内容状态将为modified，

如果要取消这次cherry-pick,则使用git cherry-pick --abort，这种情况下当前分支恢复到cherry-pick前的状态，没有改变。

git cherry-pick < branchname >

如果在git cherry-pick后加一个分支名，则表示将该分支顶端提交进cherry-pick，如：

$ git cherry-pick master

git cherry-pick …< branchname >

git cherry-pick ^HEAD < branchname >

以上两个命令作用相同，表示应用所有提交引入的更改，这些提交是branchname的祖先但不是HEAD的祖先，比如，现在我的仓库中有三个分支，其提交历史如下图：

             C<---D<---E  branch2
              /
master   A<---B  
              \
               F<---G<---H  branch3
                         |
                         HEAD

如果我使用git cherry-pick …branch2或者git cherry-pick ^HEAD branch2,那么会将属于branch2的祖先但不属于branch3的祖先的所有提交引入到当前分支branch3上，并生成新的提交，执行命令如下:

$ git cherry-pick ..branch2
[branch3 c95d8b0] [Description]:branch2  add only-for-branch2

执行后的提交历史如下：

               C<---D<---E  branch2
              /
master   A<---B  
              \
               F<---G<---H<---C'<---D'<---E'  branch3
                                          |
                                         HEAD

常见问题

The previous cherry-pick is now empty, possibly due to conflict resolution.

• 原因:
  在cherry-pick时出现冲突，解决冲突后本地分支中内容和cherry-pick之前相比没有改变，因此当在以后的步骤中继续git cherry-pick或执行其他命令时，由于此时还处于上次cherry-pick，都会提示该信息，表示可能是由于解决冲突造成上一次cherry-pick内容是空的。

• 解决方案:
  1.执行git cherry-pick --abort取消上次操作。
  2.执行git commit --allow-empty,表示允许空提交。

fatal: You are in the middle of a cherry-pick – cannot amend.

• 原因:
  在cherry-pick时出现冲突，没有解决冲突就执行git commit --amend命令，从而会提示该信息。

• 解决方案:
  首先在git commit --amend之前解决冲突，并完成这次cherry-pick:

$ git add .
$ git cherry-pick --continue