The git rebase command has a reputation for being magical Git voodoo that beginners should stay away from, but it can actually make life much easier for a development team when used with care. In this article, well compare git rebase with the related git merge command and identify all of the potential opportunities to incorporate rebasing into the typical Git workflow.
The first thing to understand about git rebase is that it solves the same problem as git merge. Both of these commands are designed to integrate changes from one branch into another branchthey just do it in very different ways.
Consider what happens when you start working on a new feature in a dedicated branch, then another team member updates the main branch with new commits. This results in a forked history, which should be familiar to anyone who has used Git as a collaboration tool.
Now, lets say that the new commits in main are relevant to the feature that youre working on. To incorporate the new commits into your feature branch, you have two options: merging or rebasing.
The easiest option is to merge the main branch into the feature branch using something like the following:
Or, you can condense this to a one-liner:
This creates a new merge commit in the feature branch that ties together the histories of both branches, giving you a branch structure that looks like this:
Merging is nice because its a non-destructive operation. The existing branches are not changed in any way. This avoids all of the potential pitfalls of rebasing (discussed below).
On the other hand, this also means that the feature branch will have an extraneous merge commit every time you need to incorporate upstream changes. If main is very active, this can pollute your feature branchs history quite a bit. While its possible to mitigate this issue with advanced git log options, it can make it hard for other developers to understand the history of the project.
As an alternative to merging, you can rebase the feature branch onto main branch using the following commands:
This moves the entire feature branch to begin on the tip of the main branch, effectively incorporating all of the new commits in main. But, instead of using a merge commit, rebasing re-writes the project history by creating brand new commits for each commit in the original branch.
The major benefit of rebasing is that you get a much cleaner project history. First, it eliminates the unnecessary merge commits required by git merge. Second, as you can see in the above diagram, rebasing also results in a perfectly linear project historyyou can follow the tip of feature all the way to the beginning of the project without any forks. This makes it easier to navigate your project with commands like git log, git bisect, and gitk.
But, there are two trade-offs for this pristine commit history: safety and traceability. If you dont follow the Golden Rule of Rebasing, re-writing project history can be potentially catastrophic for your collaboration workflow. And, less importantly, rebasing loses the context provided by a merge commityou cant see when upstream changes were incorporated into the feature.
Interactive rebasing gives you the opportunity to alter commits as they are moved to the new branch. This is even more powerful than an automated rebase, since it offers complete control over the branchs commit history. Typically, this is used to clean up a messy history before merging a feature branch into main.
To begin an interactive rebasing session, pass the i option to the git rebase command:
This will open a text editor listing all of the commits that are about to be moved:
This listing defines exactly what the branch will look like after the rebase is performed. By changing the pick command and/or re-ordering the entries, you can make the branchs history look like whatever you want. For example, if the 2nd commit fixes a small problem in the 1st commit, you can condense them into a single commit with the fixup command:
When you save and close the file, Git will perform the rebase according to your instructions, resulting in project history that looks like the following:
Eliminating insignificant commits like this makes your features history much easier to understand. This is something that git merge simply cannot do.
Once you understand what rebasing is, the most important thing to learn is when not to do it. The golden rule of git rebase is to never use it on public branches.
For example, think about what would happen if you rebased main onto your feature branch:
The rebase moves all of the commits in main onto the tip of feature. The problem is that this only happened in your repository. All of the other developers are still working with the original main. Since rebasing results in brand new commits, Git will think that your main branchs history has diverged from everybody elses.
The only way to synchronize the two main branches is to merge them back together, resulting in an extra merge commit and two sets of commits that contain the same changes (the original ones, and the ones from your rebased branch). Needless to say, this is a very confusing situation.
So, before you run git rebase, always ask yourself, Is anyone else looking at this branch? If the answer is yes, take your hands off the keyboard and start thinking about a non-destructive way to make your changes (e.g., the git revert command). Otherwise, youre safe to re-write history as much as you like.
If you try to push the rebased main branch back to a remote repository, Git will prevent you from doing so because it conflicts with the remote main branch. But, you can force the push to go through by passing the --force flag, like so:
This overwrites the remote main branch to match the rebased one from your repository and makes things very confusing for the rest of your team. So, be very careful to use this command only when you know exactly what youre doing.
One of the only times you should be force-pushing is when youve performed a local cleanup after youve pushed a private feature branch to a remote repository (e.g., for backup purposes). This is like saying, Oops, I didnt really want to push that original version of the feature branch. Take the current one instead. Again, its important that nobody is working off of the commits from the original version of the feature branch.
Rebasing can be incorporated into your existing Git workflow as much or as little as your team is comfortable with. In this section, well take a look at the benefits that rebasing can offer at the various stages of a features development.
The first step in any workflow that leverages git rebase is to create a dedicated branch for each feature. This gives you the necessary branch structure to safely utilize rebasing:
One of the best ways to incorporate rebasing into your workflow is to clean up local, in-progress features. By periodically performing an interactive rebase, you can make sure each commit in your feature is focused and meaningful. This lets you write your code without worrying about breaking it up into isolated commitsyou can fix it up after the fact.
When calling git rebase, you have two options for the new base: The features parent branch (e.g., main), or an earlier commit in your feature. We saw an example of the first option in the Interactive Rebasing section. The latter option is nice when you only need to fix up the last few commits. For example, the following command begins an interactive rebase of only the last 3 commits.
By specifying HEAD~3 as the new base, youre not actually moving the branchyoure just interactively re-writing the 3 commits that follow it. Note that this will not incorporate upstream changes into the feature branch.
If you want to re-write the entire feature using this method, the git merge-base command can be useful to find the original base of the feature branch. The following returns the commit ID of the original base, which you can then pass to git rebase:
This use of interactive rebasing is a great way to introduce git rebase into your workflow, as it only affects local branches. The only thing other developers will see is your finished product, which should be a clean, easy-to-follow feature branch history.
But again, this only works for private feature branches. If youre collaborating with other developers via the same feature branch, that branch is public, and youre not allowed to re-write its history.
There is no git merge alternative for cleaning up local commits with an interactive rebase.
In the Conceptual Overview section, we saw how a feature branch can incorporate upstream changes from main using either git merge or git rebase. Merging is a safe option that preserves the entire history of your repository, while rebasing creates a linear history by moving your feature branch onto the tip of main.
This use of git rebase is similar to a local cleanup (and can be performed simultaneously), but in the process it incorporates those upstream commits from main.
Keep in mind that its perfectly legal to rebase onto a remote branch instead of main. This can happen when collaborating on the same feature with another developer and you need to incorporate their changes into your repository.
For example, if you and another developer named John added commits to the feature branch, your repository might look like the following after fetching the remote feature branch from Johns repository:
You can resolve this fork the exact same way as you integrate upstream changes from main: either merge your local feature with john/feature, or rebase your local feature onto the tip of john/feature.
Note that this rebase doesnt violate the Golden Rule of Rebasing because only your local feature commits are being movedeverything before that is untouched. This is like saying, add my changes to what John has already done. In most circumstances, this is more intuitive than synchronizing with the remote branch via a merge commit.
By default, the git pull command performs a merge, but you can force it to integrate the remote branch with a rebase by passing it the --rebase option.
If you use pull requests as part of your code review process, you need to avoid using git rebase after creating the pull request. As soon as you make the pull request, other developers will be looking at your commits, which means that its a public branch. Re-writing its history will make it impossible for Git and your teammates to track any follow-up commits added to the feature.
Any changes from other developers need to be incorporated with git merge instead of git rebase.
For this reason, its usually a good idea to clean up your code with an interactive rebase before submitting your pull request.
After a feature has been approved by your team, you have the option of rebasing the feature onto the tip of the main branch before using git merge to integrate the feature into the main code base.
This is a similar situation to incorporating upstream changes into a feature branch, but since youre not allowed to re-write commits in the main branch, you have to eventually use git merge to integrate the feature. However, by performing a rebase before the merge, youre assured that the merge will be fast-forwarded, resulting in a perfectly linear history. This also gives you the chance to squash any follow-up commits added during a pull request.
If youre not entirely comfortable with git rebase, you can always perform the rebase in a temporary branch. That way, if you accidentally mess up your features history, you can check out the original branch and try again. For example:
And thats all you really need to know to start rebasing your branches. If you would prefer a clean, linear history free of unnecessary merge commits, you should reach for git rebase instead of git merge when integrating changes from another branch.
On the other hand, if you want to preserve the complete history of your project and avoid the risk of re-writing public commits, you can stick with git merge. Either option is perfectly valid, but at least now you have the option of leveraging the benefits of git rebase.
Visit link:
Merging vs. Rebasing | Atlassian Git Tutorial
- Madame Web Broke The Golden Rule Of Superhero Movie Villains Marvel Spent 20 Years Protecting - Screen Rant - May 15th, 2024 [May 15th, 2024]
- Kate Middleton 'breaks Queen's golden rule' after conversation with young fan - Daily Record - May 15th, 2024 [May 15th, 2024]
- This Is My New Golden Rule for Renting Vacation Homes (I Was Doing It All Wrong) - Yahoo Life - April 12th, 2024 [April 12th, 2024]
- Misguided culture warriors should heed the golden rule [column] - LNP | LancasterOnline - April 12th, 2024 [April 12th, 2024]
- Michael L. Fischler: Anger and The Golden Rule - The Union Leader - April 10th, 2024 [April 10th, 2024]
- Dog trainer reveals her golden rule for recall training (we can't believe how simple it is!) - Yahoo Life - April 10th, 2024 [April 10th, 2024]
- Fr. Aristides Palaynes and the Golden Rule Community - Greek Orthodox Archdiocese of America - Greek Orthodox Archdiocese of America - April 10th, 2024 [April 10th, 2024]
- How Lulu still looks fabulous at 75, from her skincare 'golden rule' to refusing to take lifts - as star revea - Daily Mail - April 10th, 2024 [April 10th, 2024]
- Ken Henry: We are breaking the 'golden rule' of economic policy - ABC News - April 10th, 2024 [April 10th, 2024]
- The Golden Rule and the Free Market - Foundation for Economic Education - March 6th, 2024 [March 6th, 2024]
- Courtney B. Vance and Angela Bassett share their golden rule for successful parenting - The Times of India - March 6th, 2024 [March 6th, 2024]
- Live music at The Golden Rule Coffee House on Friday, March 8 - Redwood Falls Gazette - February 29th, 2024 [February 29th, 2024]
- Blake Lively and Ryan Reynolds have always followed one relationship rule - Marie Claire UK - February 29th, 2024 [February 29th, 2024]
- The Golden Rule - A Way of Life - County 10 News - January 27th, 2024 [January 27th, 2024]
- Dear Annie: Nurses Golden Rule might be the answer to relationship problems - MLive.com - January 27th, 2024 [January 27th, 2024]
- Aitana's golden rule and the pending account she has with her most loyal audience - WECB - January 27th, 2024 [January 27th, 2024]
- Guest columnist David Hernndez: Climate, refugees, and the golden rule - GazetteNET - January 27th, 2024 [January 27th, 2024]
- A golden rule that should have been followed in North - The Sun Chronicle - January 27th, 2024 [January 27th, 2024]
- The Golden Rule Refined | | news-journal.com - Longview News-Journal - January 27th, 2024 [January 27th, 2024]
- Film About The Golden Rule Released in Bali - EIN News - January 27th, 2024 [January 27th, 2024]
- Heres a Golden Rule Jeff Bezos Seems to Have Forgotten: Never Let Your Ego Get in the Way of Doing Business - The Good Men Project - January 27th, 2024 [January 27th, 2024]
- Universalists to consider the mandate of the Golden Rule - Ashland Daily Press - November 20th, 2023 [November 20th, 2023]
- 6-Year-Old Boy Dies a Month After Adult Neighbor Allegedly Beats ... - PEOPLE - November 20th, 2023 [November 20th, 2023]
- COLUMN: Celebrate Thanksgiving year-round with 'Thanks-living ... - Andalusia Star-News - November 20th, 2023 [November 20th, 2023]
- Silence is craven, not golden - The Gazette - November 20th, 2023 [November 20th, 2023]
- Sellars CEO Named to Wisconsin 'Titan 100' - Industrial Distribution - November 20th, 2023 [November 20th, 2023]
- The most valuable decluttering lessons I have learned | - Homes & Gardens - November 20th, 2023 [November 20th, 2023]
- COMMENTARY| Bethel: Too much hate | Opinion ... - Bennington Banner - November 20th, 2023 [November 20th, 2023]
- Cooking with Love Nello's Continues Impress Diners - St. Albert Gazette - November 20th, 2023 [November 20th, 2023]
- What Happened to James Garner? Inside the 'Maverick' Star's ... - Yahoo Entertainment - November 20th, 2023 [November 20th, 2023]
- Successful trial of coating that converts UV into PAR boosts sales - hortidaily.com - November 20th, 2023 [November 20th, 2023]
- Debt rules will affect the most vulnerable, EU trade union chief warns - EURACTIV - November 20th, 2023 [November 20th, 2023]
- Guest Opinion | Bill Paparian: Pasadena City Hall Believes in the ... - Pasadena Now - May 18th, 2023 [May 18th, 2023]
- Golden ratio in venation patterns of dragonfly wings | Scientific Reports - Nature.com - May 18th, 2023 [May 18th, 2023]
- The Golden Rule Of Data Gathering And New Expectations Of Value ... - The Drum - May 18th, 2023 [May 18th, 2023]
- Glass gets away with breaking the golden rule - The Irish News - May 18th, 2023 [May 18th, 2023]
- Red Horse Recruiter Ranks First in Class - 125fw.ang.af.mil - May 18th, 2023 [May 18th, 2023]
- These 19 Birmingham BBQ joints are the ultimate Memorial Day ... - Bham Now - May 18th, 2023 [May 18th, 2023]
- Mountain West Technologies wins Casper Area Chamber of ... - Cap City News - May 18th, 2023 [May 18th, 2023]
- The Unseen Engine of South Florida's Booming Vacation Rental Market: Estaga - Yahoo Finance - May 18th, 2023 [May 18th, 2023]
- Simon Cowell to break important BGT rule this weekend, ITV confirms - South Wales Argus - May 18th, 2023 [May 18th, 2023]
- Starting out on the St. Croix: What High School Skiing Taught Jessie ... - fasterskier.com - May 18th, 2023 [May 18th, 2023]
- These are the weirdest and least understood pickleball rules and ... - msnNOW - May 18th, 2023 [May 18th, 2023]
- Media Source Not Showing in OBS? Here's How to Fix It - MUO - MakeUseOf - May 18th, 2023 [May 18th, 2023]
- Youngkin avoids talk of diversity, politics at VMI graduation - Cardinal News - May 18th, 2023 [May 18th, 2023]
- Mother's Day roots: the opposition to war | READER COMMENTARY - Baltimore Sun - May 18th, 2023 [May 18th, 2023]
- Rep. Gallagher says US needs to take off 'golden blindfolds' and 'open our eyes' to China risk - Fox News - May 18th, 2023 [May 18th, 2023]
- Open Heaven 18 May 2023: The Gift of Love - ELANHUB MEDIA - May 18th, 2023 [May 18th, 2023]
- 10 Best Quotes About Family In The Fast & Furious Franchise - CBR - Comic Book Resources - May 18th, 2023 [May 18th, 2023]
- Life in the Fast Lane - New DOE Rule Changes Push LNG Projects ... - RBN Energy - May 18th, 2023 [May 18th, 2023]
- Dont Say That Word- Days After Golden Advice From Wrexhams Ryan Reynolds, NFL Icon JJ Watt Reminds Wife of Unspoken Rule After Burnley Investment -... - May 18th, 2023 [May 18th, 2023]
- 14 Handy Tricks To Get Better Sleep While Backpacking - The Trek - May 18th, 2023 [May 18th, 2023]
- Investors overlooking the golden rule as they flock to DIY apps - Stuff - April 29th, 2023 [April 29th, 2023]
- 7 money 'rules' you can actually break, according to financial experts - MarketWatch - April 29th, 2023 [April 29th, 2023]
- Dorsman: MP Motorsport betting on caution ahead of inevitable ... - Formula 2 - April 29th, 2023 [April 29th, 2023]
- Boomer explains why millennials are having a hard time at work: 'It's ... - Upworthy - April 29th, 2023 [April 29th, 2023]
- AFA.net - Basic Fairness in Women's Sports - American Family Association - April 29th, 2023 [April 29th, 2023]
- How To Prep Air Fryer Vegetables So They Don't Escape The Basket - Tasting Table - April 29th, 2023 [April 29th, 2023]
- Pansexual Flag: Here's what the Pride Flag's colors mean and more - USA TODAY - April 29th, 2023 [April 29th, 2023]
- What is the "Rules-Based-Order"? - CounterPunch.org - CounterPunch - April 29th, 2023 [April 29th, 2023]
- Hudson WWII vet turns 100, decides to quit the bocce ball team - Suncoast News - April 29th, 2023 [April 29th, 2023]
- Kansas City reportedly let Meta developer break diversity rules, then ... - KCUR - April 29th, 2023 [April 29th, 2023]
- From the Right: Drawing the line between trans rights and parental ... - The Malibu Times - April 29th, 2023 [April 29th, 2023]
- I was 40,000 in debt but got myself out of it here is the rule I swear by and how it changed my life... - The Sun - April 29th, 2023 [April 29th, 2023]
- OBITUARY - Mary Anderson - Berthoud Weekly SurveyorBerthoud ... - BerthoudSurveyor.com - April 29th, 2023 [April 29th, 2023]
- 8 ways to improve your written communications - Smartbrief - April 29th, 2023 [April 29th, 2023]
- Draymond Green: Draymond wont be moved by the Draymond rule - Eurohoops - April 29th, 2023 [April 29th, 2023]
- Dont Make These 4 Nursing Home Abuse Claim Mistakes in Las ... - Legal Reader - April 29th, 2023 [April 29th, 2023]
- What Food to Pack for Family Hikes - Outside - April 29th, 2023 [April 29th, 2023]
- Lawyer Discernment Is Critical In The World Of AI - JD Supra - April 29th, 2023 [April 29th, 2023]
- 12 blockbuster movies for summer 2023 ranked: we can't wait! - What To Watch - April 29th, 2023 [April 29th, 2023]
- Meghan broke 'golden rule' months before royal exit and has done so ever since - Express - April 20th, 2023 [April 20th, 2023]
- We Are All Connected: Loving One Another in Different Religions - Graphic - April 20th, 2023 [April 20th, 2023]
- Grammar Girl AP style tips on the Oxford comma, headlines and more - PR Daily - April 20th, 2023 [April 20th, 2023]
- How to prevent HVAC havoc this summer - KCAU 9 - April 20th, 2023 [April 20th, 2023]
- Take the right care of your yard | News | hometownnewsbrevard.com - Hometown News - April 20th, 2023 [April 20th, 2023]
- Britain's Got Talent: Simon Cowell speaks out after new judge Bruno Tonioli breaks rule on first appearance - LADbible - April 20th, 2023 [April 20th, 2023]
- After experimenting with directives, ISSF reinstates the Tokyo Olympics old-golden rule book for Paris 2024 - Free Press Journal - April 20th, 2023 [April 20th, 2023]
- Want to stay married? Gogglebox's Steph and Dom reveal golden ... - Daily Mail - April 20th, 2023 [April 20th, 2023]
- Overcoming Spiritual Violence and Embracing Peace with Rev. Dr ... - Bear World Magazine - April 20th, 2023 [April 20th, 2023]