This is an abbreviated version of a fuller post about Git Rebase in Eclipse. See the longer one here:
One side-effect of merging Git branches is that it leaves a Merge commit. This can create a history view something like:
One side-effect of merging Git branches is that it leaves a Merge commit. This can create a history view something like:
The clutter of parallel lines shows the life spans of those local branches, and extra commits (nine in the above screen-shot, marked by the green arrows icon).
Check out this extreme-case history: http://agentdero.cachefly.net/unethicalblogger.com/images/branch_madness.jpeg
Others may find it unnecessarily long and cluttered. They prefer the history to tell the bigger story, and not dwell on tiny details like every trivial Merge-commit.
Git Rebase offers us 2 benefits over Git Merge:
First, Rebase allows us to clean up a set of local commits before pushing them to the shared, central repository. For this, the Eclipse EGit Rebase Interactive tool is helpful in rewording, squashing etc. several commits into a smaller number of more logical chunks;
Second, Rebase lets us merge branches more cleanly, with fewer Merge-commits left over.
#2 is what we need in order to bring our changes from one branch onto another branch, in a way that avoids the parallel lines and merge commits in the above image.
As always in Rebasing, think locally. That is:
Do not rebase commits that exist outside your local repository
How to Rebase Branches in Eclipse:
In this example, I have 2 local branches: "dev" that matches the branch on an upstream central repository, and "Project93979", a local branch for a new feature or a bug fix.
In this example, I have 2 local branches: "dev" that matches the branch on an upstream central repository, and "Project93979", a local branch for a new feature or a bug fix.
Now I am done and ready to merge the branch into the dev branch and be pushed upstream.
To Rebase instead of Merge in Eclipse, I follow these steps:
- Check out me dev branch by double-clicking on it.
- Pull from the upstream repository to make sure dev branch is up to date.
- Check out the Project93979 branch again.
- Right-click on the dev branch and select Rebase On.
- If there are conflicts, do the usual manual-merge conflict-resolution work. There is one catch: If multiple commits include changes to a file that made conflicts, I need to resolve the conflict for each of those commits (in a Merge, you resolve it just once).
Eclipse will notify you of conflicts with a dialog like this (in Eclipse Mars):
- Click OK to start the Merge Tool. Use the Merge Tool to navigate the conflicts and copy or change the source as needed to resolve the conflicts.
- Once the changes are completed, save the merged files and switch to the Git Staging view. The conflicting file may still have the red Conflict icon decorator in the Unstaged Changes box, but since they are resolved and saved, right-click and add them to the Index. The Conflict decorator is replaced with the Changes decorator and the Commit button is enabled.
In the above image, the Continue button is also enabled at this point. That is because Rebase is replaying the series of commits we made on this branch onto the new starting-point commit. “Continue” lets us move forward, either to the rest of the commits, or to the rest of the Rebase process.
Once the conflicts are handled, branch Project93979 has been Rebased to look how it would have had the branch been created from the very latest of the dev branch and then all the changes were made. This is the goal of Rebase and, when there are no conflicts, Git handles this very nicely.
This has only changed the Project93979 branch, not the dev branch yet. To complete the Rebase of dev, essentially merging Project93979 into dev without the Merge Commit, we must still Rebase the dev branch.
This has only changed the Project93979 branch, not the dev branch yet. To complete the Rebase of dev, essentially merging Project93979 into dev without the Merge Commit, we must still Rebase the dev branch.
- Check out the dev branch again. Right-click on the Project93979 branch, then select Rebase On. This should be fast and trivial, since we already resolved all of the conflicts above. It should just be what Git calls a Fast-Forward.
- Dev branch is now ready to push upstream. Whatever commits were in the Project93979 branch should now appear in the history of the dev branch, but with no Merge-commit and no clutter of parallel lines showing branches that never really existed on the remote repository. The image below is the Eclipse Git History view, and you can see that the Project93979 branch has been brought together with the dev branch cleanly.