git cherry-pick 教程

作者: 阮一峰

日期: 2020年4月27日

对于多分支的代码库,将代码从一个分支转移到另一个分支是常见需求。

这时分两种情况。一种情况是,你需要另一个分支的所有代码变动,那么就采用合并(git merge)。另一种情况是,你只需要部分代码变动(某几个提交),这时可以采用 Cherry pick。

一、基本用法

git cherry-pick命令的作用,就是将指定的提交(commit)应用于其他分支。


$ git cherry-pick <commitHash>

上面命令就会将指定的提交commitHash,应用于当前分支。这会在当前分支产生一个新的提交,当然它们的哈希值会不一样。

举例来说,代码仓库有masterfeature两个分支。


    a - b - c - d   Master
         \
           e - f - g Feature

现在将提交f应用到master分支。


# 切换到 master 分支
$ git checkout master

# Cherry pick 操作
$ git cherry-pick f

上面的操作完成以后,代码库就变成了下面的样子。


    a - b - c - d - f   Master
         \
           e - f - g Feature

从上面可以看到,master分支的末尾增加了一个提交f

git cherry-pick命令的参数,不一定是提交的哈希值,分支名也是可以的,表示转移该分支的最新提交。


$ git cherry-pick feature

上面代码表示将feature分支的最近一次提交,转移到当前分支。

二、转移多个提交

Cherry pick 支持一次转移多个提交。


$ git cherry-pick <HashA> <HashB>

上面的命令将 A 和 B 两个提交应用到当前分支。这会在当前分支生成两个对应的新提交。

如果想要转移一系列的连续提交,可以使用下面的简便语法。


$ git cherry-pick A..B 

上面的命令可以转移从 A 到 B 的所有提交。它们必须按照正确的顺序放置:提交 A 必须早于提交 B,否则命令将失败,但不会报错。

注意,使用上面的命令,提交 A 将不会包含在 Cherry pick 中。如果要包含提交 A,可以使用下面的语法。


$ git cherry-pick A^..B 

三、配置项

git cherry-pick命令的常用配置项如下。

(1)-e--edit

打开外部编辑器,编辑提交信息。

(2)-n--no-commit

只更新工作区和暂存区,不产生新的提交。

(3)-x

在提交信息的末尾追加一行(cherry picked from commit ...),方便以后查到这个提交是如何产生的。

(4)-s--signoff

在提交信息的末尾追加一行操作者的签名,表示是谁进行了这个操作。

(5)-m parent-number--mainline parent-number

如果原始提交是一个合并节点,来自于两个分支的合并,那么 Cherry pick 默认将失败,因为它不知道应该采用哪个分支的代码变动。

-m配置项告诉 Git,应该采用哪个分支的变动。它的参数parent-number是一个从1开始的整数,代表原始提交的父分支编号。


$ git cherry-pick -m 1 <commitHash>

上面命令表示,Cherry pick 采用提交commitHash来自编号1的父分支的变动。

一般来说,1号父分支是接受变动的分支(the branch being merged into),2号父分支是作为变动来源的分支(the branch being merged from)。

四、代码冲突

如果操作过程中发生代码冲突,Cherry pick 会停下来,让用户决定如何继续操作。

(1)--continue

用户解决代码冲突后,第一步将修改的文件重新加入暂存区(git add .),第二步使用下面的命令,让 Cherry pick 过程继续执行。


$ git cherry-pick --continue

(2)--abort

发生代码冲突后,放弃合并,回到操作前的样子。

(3)--quit

发生代码冲突后,退出 Cherry pick,但是不回到操作前的样子。

五、转移到另一个代码库

Cherry pick 也支持转移另一个代码库的提交,方法是先将该库加为远程仓库。


$ git remote add target git://gitUrl

上面命令添加了一个远程仓库target

然后,将远程代码抓取到本地。


$ git fetch target

上面命令将远程代码仓库抓取到本地。

接着,检查一下要从远程仓库转移的提交,获取它的哈希值。


$ git log target/master

最后,使用git cherry-pick命令转移提交。


$ git cherry-pick <commitHash>

(完)

留言(16条)

使用和 rebase --onto 很相似

引用niexia的发言:

使用和 rebase --onto 很相似

rebase的本质和cherry-pick是相同的

从上面可以看到,master分支的末尾增加了一个提交f。
更精确地说是f',不是f。因为生成了一个新的commit,和f是不同的commit,仅仅是commit和上一个commit的diff相同(在不冲突的前提下)。

前些天,提交代码到测试环境,影响到正在进行的测试任务进度(具体就是我的代码业务导致正在测试业务走不通。。),测试同事让我回滚代码提交。实习生的我还没用过回滚,询问同事给我建议的就是“摘樱桃”,鉴于情况紧急直接提交覆盖了。。。
现在看来“摘樱桃”也不是准确用来回滚的哎

引用小贤的发言:

前些天,提交代码到测试环境,影响到正在进行的测试任务进度(具体就是我的代码业务导致正在测试业务走不通。。),测试同事让我回滚代码提交。实习生的我还没用过回滚,询问同事给我建议的就是“摘樱桃”,鉴于情况紧急直接提交覆盖了。。。
现在看来“摘樱桃”也不是准确用来回滚的哎

按描述的理解直接cherry-pick貌似没法解决吧。
可以先revert掉你影响测试的commit,然后重新这段业务的时候,可以cherry-pick -n之前影响测试的commit,然后进行修改后再提交。

什么时候出个英语教程

希望在线练习git-cherry-pick也可以访问《开源中国在线 Git 命令学习》
https://oschina.gitee.io/learn-git-branching/

阮老师总能化繁为简,抓住重点????,最后合并远程的例子还顺便回顾了操作远程分支的命令

感觉不信任cherry-pick,尤其是两个分支差异比较大时

一直用git checkout --patch branch file...

求解惑 git cherry-pick --ff 是在什么场景下使用,有何用处?

有一个案例就好了

坦率的讲,这是阮老师写的“比较不好”的一篇技术文章:cherry-pick有很严重问题,文章里根本没提到,参见微软Raymond Chen 的文章 https://devblogs.microsoft.com/oldnewthing/20180312-00/?p=98215

一直在用,经常在不同分支修复问题,即时同步就是用的这个cherry-pick

引用邱朗的发言:

坦率的讲,这是阮老师写的“比较不好”的一篇技术文章:cherry-pick有很严重问题,文章里根本没提到,参见微软Raymond Chen 的文章 https://devblogs.microsoft.com/oldnewthing/20180312-00/?p=98215

多谢提供扩展阅读

阮老师,$ git cherry-pick A..B
应该是A到B的提交转移,并且不包含B的提交吧

我要发表看法

«-必填

«-必填,不公开

«-我信任你,不会填写广告链接