When you are working with a team of developers on a medium to large sized project, managing the changes between a number of git branches can become a complex task. Sometimes you don't want to merge a whole branch into another, and only need to pick one or two specific commits. This process is called 'cherry picking'.
When should we use Cherry Picking?
I will try to explaining this through a scenario which will make it easier to understand.
Let’s say you are working in an project where you are making changes in a branch called new-features. You have already made a few commits but want to move just one of them into the master branch.
- From new-features branch run git log --oneline to get a better log of your commits history. Note that the commit hash is what we need to start the cherry picking. For example:
- Checkout the branch where you want to cherry pick the specific commits. In this case master branch:
git checkout master
- Now we can cherry pick from new-features branch:
git cherry-pick d467740
This will cherry pick the commit with hash d467740 and add it as a new commit on the master branch. Note: it will have a new (and different) commit ID in the master branch.
If you want to cherry pick more than one commit in one go, you can add their commit IDs separated by a space:
git cherry-pick d467740 de906d4
- If the cherry picking gets halted because of conflicts, resolve them and
git cherry-pick --continue
- If you want to bail of this step out altogether, just type:
git cherry-pick --abort
After all this is done, you can simply push the new commits to the upstream repo (e.g origin) and get on with your day.
Tips n Tricks
In case you needed to cherry pick a merge instead of a commit, you can use:
git cherry-pick -m 1 <hash>
Caution!
Cherry picking is commonly discouraged in developer community. The main reason is because it creates a duplicate commit with the same changes and you lose the ability to track the history of the original commit. If you can merge, then you should use that instead of cherry picking. Use it with caution!
Further Reading
Here is some good material for broadening your knowledge:
-
https://www.devroom.io/2010/06/10/cherry-picking-specific-commits-from-another-branch/
-
http://think-like-a-git.net/sections/rebase-from-the-ground-up/cherry-picking-explained.html
Comments
Nice article, thank you!
This is a brilliant, short, to-the-point guide. Bookmarking it as my git-cherry-pick cheat sheet :)
Nice explanation!
I work in an application that is default for most clients but there are two clients that have it a little bit customized, so I use the same git repository but different branches to develop for those two separate clients.
When I want to add a feature from the default app to a customized one, I have two options:
Use merge or Pull Requests, it'll bring the past history along with it.
Cherry pick, bring only specific changes and ignore the past history.
I learned Cherry pick recently and it has helped me very much.
I use cherry pick to add a feature from the default app to a customized one, when I don't want to bring the past history of that feature.
Very nicely done, thank you for that!
Very well to-the-point explanation. Thanks.
Very clear explanation. Thanks.
Nice explanation...
Awesome handy note. Thanks For sharing!!
Thank youuu for free sharing of knowledge! :)
this is cool article ! understood it all in one read. Thanks :D
Very simple and helpful. Thanks
An article to the point explained and easily understandable. Thank you.
Simply superb and helpful.
Damn this tutorial was so smooth. GJ
Thank you for the great explanation. One question I have is, what happens when you try to merge the branch that you cherry picked from into the branch that you've cherry picked to? Using your example, what happens when the rest of your "new-features" branch is ready to be merged into master? Will the merge have conflicts from trying to merge in code that's already changed? Should I rebase my "new-features" branch and remove the commits that I cherry picked out?
That's awesome, thanks for sharing
Short and sweet. Thanks for the help.
Nice page! Thank you!
Comment by Lesly
Dated