Cherry-pick changes

DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

In Git, cherry-picking is taking a single commit from one branch and adding it as the latest commit on another branch. The rest of the commits in the source branch are not added to the target. Cherry-pick a commit when you need the contents in a single commit, but not the contents of the entire branch. For example, when you:

Backport bug fixes from the default branch to previous release branches.
Copy changes from a fork to the upstream repository.

Use the GitLab UI to cherry-pick a single commit or the contents of an entire merge request from a project or a project fork.

In this example, a Git repository has two branches: develop and main. Commit B is cherry-picked from the develop branch after commit E in the main branch. Commit G is added after the cherry-pick:

gitGraph
 commit id: "A"
 branch develop
 commit id:"B"
 checkout main
 commit id:"C"
 checkout develop
 commit id:"D"
 checkout main
 commit id:"E"
 cherry-pick id:"B"
 commit id:"G"
 checkout develop
 commit id:"H"

Cherry-pick all changes from a merge request

After a merge request is merged, you can cherry-pick all changes introduced by the merge request. The merge request can be in the upstream project or in a downstream fork.

Prerequisites:

You must have a role in the project that allows you to edit merge requests, and add code to the repository.
Your project must use the merge method Merge Commit, which is set in the project's Settings > Merge requests.

In GitLab 16.9 and later, fast-forwarded commits can be cherry-picked from the GitLab UI only when they are squashed or when the merge request contains a single commit. You can always cherry-pick individual commits.

To do this:

On the left sidebar, select Search or go to and find your project.
Select Code > Merge requests, and find your merge request.
Scroll to the merge request reports section, and find the Merged by report.
In the upper-right corner of the report, select Cherry-pick:
On the dialog, select the project and branch to cherry-pick into.
Optional. Select Start a new merge request with these changes.
Select Cherry-pick.

Cherry-pick a single commit

You can cherry-pick a single commit from multiple locations in your GitLab project.

From a project's commit list

To cherry-pick a commit from the list of all commits for a project:

On the left sidebar, select Search or go to and find your project.
Select Code > Commits.
Select the title of the commit you want to cherry-pick.
In the upper-right corner, select Options > Cherry-pick.
On the cherry-pick dialog, select the project and branch to cherry-pick into.
Optional. Select Start a new merge request with these changes.
Select Cherry-pick.

From the file view of a repository

You can cherry-pick from the list of previous commits affecting an individual file when you view that file in your project's Git repository:

On the left sidebar, select Search or go to and find your project.
Select Code > Repository.
Go to the file changed by the commit. In the upper-right corner, select History.
Select the title of the commit you want to cherry-pick.
In the upper-right corner, select Options > Cherry-pick.
On the cherry-pick dialog, select the project and branch to cherry-pick into.
Optional. Select Start a new merge request with these changes.
Select Cherry-pick.

From the command line

You can cherry-pick commits from one branch to another using the git command-line interface.

In this example, you cherry-pick a commit from a feature branch (feature) into a different branch (develop).

Check out the default branch, then check out a new develop branch based on it:
```
git checkout main
git checkout -b develop
```
Change back to the feature branch:
```
git checkout feature
```

Make your changes, then commit them:

git add changed_file.rb
git commit -m 'Fix bugs in changed_file.rb'

Display the commit log:

$ git log

commit 0000011111222223333344444555556666677777
Merge: 88888999999 aaaaabbbbbb
Author: user@example.com
Date:   Tue Aug 31 21:19:41 2021 +0000

Identify the commit line, and copy the string of letters and numbers on that line. This information is the SHA (Secure Hash Algorithm) of the commit. The SHA is a unique identifier for this commit, and you need it in a future step.
Now that you know the SHA, check out the develop branch again:
```
git checkout develop
```
Cherry-pick the commit into the develop branch, and change SHA to your commit SHA:
```
git cherry-pick SHA
```

View system notes for cherry-picked commits

When you cherry-pick a merge commit in the GitLab UI or API, GitLab adds a system note to the related merge request thread. The format is {cherry-pick-commit} [USER] picked the changes into the branch [BRANCHNAME] with commit** [SHA] [DATE]:

The system note crosslinks the new commit and the existing merge request. Each deployment's list of associated merge requests includes cherry-picked merge commits.

Commits cherry-picked outside the GitLab UI or API do not add a system note.

Troubleshooting

Selecting a different parent commit when cherry-picking

When you cherry-pick a merge commit in the GitLab UI, the mainline is always the first parent. Use the command line to cherry-pick with a different mainline.

Here's a quick example to cherry-pick a merge commit using the second parent as the mainline:

git cherry-pick -m 2 7a39eb0