Apply changes from one Git branch to another
In Git, there are several ways to integrate changes from one branch into another:
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:
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:
When you run merge
, the changes from your feature branch are integrated into the HEAD of the target branch:
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
In the Branches popup (main menu ) or in the Branches pane of the Git tool window, select the target branch that you want to integrate the changes to, and choose Checkout from the context menu to switch to that branch.
Do one of the following:
If you do not need to specify options for the merge, select the branch that you want to merge into the current branch and choose Merge into Current from the submenu.
If you need to specify merge options, from the main menu choose Merge dialog:
to open theSelect the branch that you want to merge into the current branch, click Modify options and choose from the following:
--no-ff
: a merge commit will be created in all cases, even if the merge could be resolved as a fast-forward.--ff-only
: the merge will be resolved only if it is possible to fast-forward.--squash
: a single commit with all pulled changes will be created on top of the current branch.-m
: you will be able to edit the message for the merge commit.--no-commit
: a merge will be performed, but a merge commit will not be created so that you can inspect the result of the merge before committing.
Click Merge.
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 tab of the Git tool window Alt+9:
If conflicts occur between your branch and the target branch, you will be prompted to resolve them (refer to Resolve conflicts). If there are unresolved conflicts left after a merge, the Merge Conflicts node will appear in the corresponding changelist in the 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 (git-rebase)
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.
Suppose you have created a feature branch to work on a specific task and make several commits to that branch:
While you develop in your branch, your teammates continue to commit their work to master:
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 a branch on top of another branch
From the main menu select
:From the list, select the target branch onto which you want to rebase the current branch:
If you need to rebase the source branch starting from a particular commit instead of rebasing the entire branch, click Modify options and choose --onto. In the source branch field, enter the hash of the commit starting from which you want to apply the current branch to the new base:
If the branch you want to rebase is not currently checked out, click Modify options, click Select another branch to rebase, and choose a branch from the list that appears:
PyCharm will check out this branch before starting the rebase operation.
If you want to rebase all commits reachable in the branch, click Modify options and choose --root (for more information on this option, refer to git-rebase).
If you need to keep empty commits, which are commits that do not change anything from their parent, click Modify options and choose --keep-empty (for more information on this option, refer to git-rebase).
If you want to preserve merge commits during the rebase for the sake of keeping them in the branch history, click Modify options and choose --preserve-merges (this option is unavailable for
interactive
rebase).Click Rebase.
If you do not need to specify options for the rebase, you can initiate a rebase without invoking the rebase dialog. In the Branches popup or in the Branches pane of the Git tool window select a branch and choose one of the following actions:
Pull into Current Using Rebase (for remote branches) to fetch changes from the selected branch and rebase the current branch on top of these changes.
Checkout and Rebase onto Current (for both remote and local branches) to check out the selected branch and rebase it on top of the branch that is currently checked out. If the remote branch doesn't exist locally, PyCharm will silently create a tracked local branch, checkout into it and rebase.
Rebase Current onto Selected (for both remote and local branches) to rebase the branch that is currently checked out on top of the selected.
For more information about skipping or squashing commit during a rebase, refer to Edit project history by performing interactive rebase.
Watch this video to get a better view on how rebase operation can be performed:
Cherry-pick separate commits
Sometimes you only need to apply a single 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.
The status of a cherry-pick operation is displayed in the status bar. You can always abort an ongoing cherry-pick by selecting Abort Cherry-Pick in the Git Branches popup.
Apply a commit to another branch
In the Branches popup (main menu ), select the target branch that you want to integrate the changes to and choose Checkout from the popup menu to switch to that branch.
Open the Git tool window Alt+9 and switch to the Log tab.
Locate the commit containing the changes you want to cherry-pick.
You can filter commits by branch, user or date. You can also click on the toolbar and select Highlight | Non-Picked Commits option 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 Control+F in the Log tab of the Git tool window Alt+9, or click on the toolbar).
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.
Click Cherry-pick on the toolbar. PyCharm will apply and commit changes to the target branch.
If the cherry-pick failed with conflicts, the selected changes will appear in the Changes area that you can see in the Changes view. You can review these changes and commit them later if necessary.
If you want PyCharm to create changelists automatically in case of cherry-pick fail, switch on the corresponding setting in
.Push the changes to the target branch.
Apply separate changes
Imagine you've made some changes to a file that you want to apply to a different branch, but these changes were committed together with other modified files. PyCharm lets you apply separate changes instead of cherry-picking an entire commit.
In the Branches popup (main menu ), select the target branch that you want to integrate the changes to and choose Checkout from the popup menu to switch to that branch.
Open the Git tool window Alt+9 and switch to the Log tab.
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 on the toolbar and select Highlight | Non-Picked Commits option 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 Control+F in the Log tab of the Git tool window Alt+9, or click on the toolbar).
In the Commit details pane on the right, select the files containing the changes you want to apply to the target branch and select Cherry-Pick Selected Changes from the context menu.
In the dialog that opens, select an existing changelist or enter the name for a new changelist and click OK.
Commit the changes and then push them to the target branch.
Apply separate files
In addition to applying separate changes to a single file, you can copy an entire file's contents to a different branch. This may be useful, for example, if the file you want to apply doesn't exist in the target branch, or if changes to it were made within several commits.
Switch to the branch to which the changes will be applied.
In the Branches popup (main menu ) or in the Branches pane of the Git tool window, select the branch that contains the file you want to apply and choose Show Diff with Working Tree from the context menu.
The Changes tool window that opens shows a list of all files that are different in the selected branch compared with the branch that is currently checked out:
Files that exist in the selected branch and are missing in the current branch are marked with grey.
Files that exist in the current branch but are missing in the selected branch are marked with green.
Files that contain differences between the selected and the current branch are marked with blue.
You can click the Swap Branches link to change which branch is considered as a base against which you are comparing the other branch.
Select the file that you want to apply to the current branch, and choose Get from Branch from the context menu or click on the toolbar .
Commit and push the changes. PyCharm will copy the entire contents of the file to the current branch.