PyCharm 2019.1 Help

Apply changes from one branch to another

In Git, there are several ways to integrate changes from one branch into another: Merge branches, Rebase branches, or Apply separate commits from one branch to another (cherry-pick).

Merge branches

Suppose you have created a feature branch to work on a specific task, and want to integrate the results of your work into the main code base after you have completed and tested your feature:

feature branch diagram

Merging your branch into master is the most common way to do this.

It is very common that while you are working in your feature branch, your teammates continue to commit their work to master:

feature branch diverge from master diagram

When you run merge, the changes from your feature branch are integrated into the HEAD of the target branch:

merge result diagram
Git creates a new commit (M) that is referred to as a merge commit that results from combining the changes from your feature branch and master from the point where the two branches diverged.

Merge branches

  1. In the Branches popup select the target branch that you want to integrate the changes to and choose Checkout from the popup menu to switch to that branch.

  2. Click the Branches popup at the bottom of the PyCharm window, select the branch that you want to merge into the target branch and choose Merge into Current from the submenu.

If your working tree is clean (which means you have no uncommitted changes), and no conflicts occur between your feature branch and the target branch, Git will merge the two branches, and the merge commit will appear in the Log:

merge commit

If conflicts occur between your branch and the target branch, you will be prompted to resolve them (see Resolve conflicts). If there are unresolved conflicts left after a merge, the Merge Conflicts node will appear in the corresponding changelist in the Local Changes view with a link to resolve them.

If you have local changes that will be overwritten by merge, PyCharm will suggest performing Smart merge. If you select this option, PyCharm will stash uncommitted changes, perform merge, and then unstash the changes.

Rebase branches

When you rebase a branch onto another branch, you apply the commits from the first branch on top of the HEAD commit in the second branch instead of merging them into the target branch.

Suppose you have created a feature branch to work on a specific task and make several commits to that branch:

feature branch diagram

While you develop in your branch, your teammates continue to commit their work to master:

feature branch diverge from master diagram

When you perform the rebase operation you integrate changes you have done in your feature branch to the master branch by applying your commits on top of the current HEAD commit in master:

rebase result diagram

Rebase the current branch on top of another branch

  1. In the Branches popup, select the branch that you want to rebase the current branch onto.

  2. Choose Rebase Current onto Selected from the popup menu.

Rebase a branch on top of the current branch

  1. In the Branches popup, select the branch that you want to rebase on top of the current branch.

  2. Choose Checkout and Rebase onto Current from the popup menu.

For details on how to skip or squash commit during a rebase, refer to Edit project history by performing interactive rebase.

Watch this video to see how a merge or a rebase operation are reflected in the Log view:


Cherry-pick separate commits

Sometimes you only need to apply a single commit (or even changes to a single file from a commit) to a different branch instead of rebasing or merging an entire branch. This may be useful, for example, if you are working in a feature branch and want to integrate a hotfix from master that was committed after the two branches have diverged. Or you may want to backport a fix to a previous release branch. You can do so by using the Cherry-pick action.

Apply an entire commit to another branch

  1. In the Branches popup select the target branch that you want to integrate the changes to and choose Checkout from the popup menu to switch to that branch.

  2. Open the Version Control tool window (Alt+9) and switch to the Log tab.

  3. Locate the commit containing the changes you want to cherry pick.

    You can filter commits by branch, user or date. You can also click eye icon on the toolbar and select Highlight | Non-Picked Commits button non picked commits to grey out the commits that have already been applied to the current branch. If you know the commit hash, or are looking for a tagged commit, you can also use the Go to Hash / Branch / Tag action (press Ctrl+F in the Log view, or click icons actions find svg on the toolbar).

  4. Select the required commit. Use the information in the Commit Details area to make sure these are the changes you want to transfer to another branch.

  5. Click the Cherry-pick button platform impl icons cherryPick svg on the toolbar. PyCharm will display the Commit Changes dialog with the automatically generated commit message. If you want to review the changes or even modify the code before committing it to the target branch, you can do so in the difference viewer available from this dialog.

  6. When done, click Commit to cherry-pick the selected changes.

    Note that if you click Cancel, a separate changelist will be created with the selected changes that you can see in the Local Changes tab. You can review these changes and commit them later if necessary.

  7. Push the changes to the target branch.

Apply separate changes

  1. In the Branches popup select the target branch that you want to integrate the changes to and choose Checkout from the popup menu to switch to that branch.

  2. Open the Version Control tool window (Alt+9) and switch to the Log tab.

  3. Locate the commit that contains the changes that you want to apply.

    You can filter commits by branch, user or date. You can also click eye icon on the toolbar and select Highlight | Non-Picked Commits button non picked commits to grey out the commits that have already been applied to the current branch. If you know the commit hash, or are looking for a tagged commit, you can also use the Go to Hash / Branch / Tag action (press Ctrl+F in the Log view, or click icons actions find svg on the toolbar).

  4. In the Commit Details pane on the right, select the files containing the changes you want to apply to the target branch and select Apply Selected Changes from the context menu.

  5. In the dialog that opens, select an existing changelist or enter the name for a new changelist and click OK.

  6. Commit the changes and then push them to the target branch.

Last modified: 17 May 2019