Skip to main content

Git magic - Squash commits

Back with another git magic. When it comes to merging a pull request on Github, there are two options

  • Rebase and Merge
  • Squash and Merge

What is Rebase and Merge?

When one chooses Rebase and Merge, all the commits in the PR are added to the target branch. For example, if the PR has 5 commits, all of those commits will be visible in the PR history of the target branch.

What is Squash and Merge?

When a PR is merged by choosing Squash and Merge, all the commits in the PR are combined into one PR and then added to the target branch. Once again, if the PR has 5 commits or any number of commits, they are combined and added to the target branch.

Therefore, this is what Squash means. Combining 'n' different commits into one single commit is called squashing. In this blog post, we will go through the commands that can squash commits. 

Advantages of Squashing commits

No more redundant commits

In a pull request, one may have 'n' different commits for one change. They might have been commits that were created due to addressing various review comments or fixing bugs that were found later. While you can amend the existing commit, what if you created those commits already? That is when squash commits come into the picture making the redundant commits go away.

Better grouping

In the case of squashing and merging, although your PR has 'n' different commits that aren't redundant but are not required to be separate in the main branch, squash groups it thereby logically grouping those commits into a single feature (or) fix commit. 

Easy to track

Due to squashed commits, the history is simpler and logically grouped without any redundant commits. Therefore, it is easy to track the changes with Git Lens / Git Blame. 

How to squash a commit?

/**
 * 
@disclaimer
 * Please read this post fully before executing any command. My scenario might not be the same as yours.
*/
Let us assume you have the following commit history which we can list using git log --oneline as follows,
git log --oneline
Now, let's say you want to squash the first three commits together. To do this, we will have to begin an interactive rebase as follows,
git rebase -i HEAD~3
An editor like below will open,
When this editor opens, to squash the top three commits, change the pick commands of the two commits into squash as shown below,
Now, the commits that are mentioned as squash will be combined with the top commit mentioned as pick. At this point, please solve any conflicts, stage those files and do a git rebase --continue.

Once all the conflicts are solved, an editor will open again asking to choose a commit message. At this point, you can either choose one of those messages by commenting everything else or you can choose to write a new commit message. I will comment all the existing commit messages and enter a new commit message as shown below,
Write the above file and tada! Your squashing is successful and you'll see a message as shown below,
Please note that, once the squashing is done for the commits that are already pushed to remote, one needs to force push. Please do a force push only on your branch and not on the default or feature branches. Happy exploring!

Comments

Popular posts from this blog

Git - Removing a file from a commit

Once again, another git magic that might be of help to some of you. This research came up when I accidentally added a couple of unwanted files and wanted to remove them from a commit. We all know that to update an existing commit, we shall follow this git magic to amend commits . However, how do we drop changes to a particular file in a commit? While that is easy, it is also tricky. This blog post covers scenarios and respective commands that help you understand what should be done. /**  *  @disclaimer  * Please read this post fully before executing any command. My scenario might not be the same as yours. */ There are two scenarios to be handled here, Remove a newly added file Remove changes to an existing file Let's look at them separately, Remove a newly added file This is the scenario where an unwanted file added to the commit. This file might be some config.json that got generated while doing a research on a new testing tool or a bundling tool. Such scenarios are easier. 1. Re

WebRTC - What the heck?

Over the past few weeks, I happened to work on stuff that enabled me to understand what WebRTC is and how useful it is.  The full form? Web R eal- T ime C ommunication The history It's first release was by 2011. If you want to know more, well, please read the wikipedia . WebRTC  has been a boon to web developers who want to build streaming applications or video calling applications. As you move downward, you'll just may be understand how WebRTC works but nothing technicals.  The story Let's begin with a short story. Long long ago, so long ago, nobody knew how long ago, there lived two shop keeper farmers John & Finch. It was that old point in time when barter system was a thing and money wasn't invented.  These shopkeepers lived in different cities across a river and the cities were connected by a rock solid bridge. Like how the golden gate connects the San Francisco city and the Marin County. Finch is a very private person and takes hard time to trust people. John

Git - How to drop a commit in history?

Back after a while with another git magic. We already have seen how to get rid of the top most commit in this article ->  Git magic - Make commits disappear First of all, it's one of the not so recommended way of doing it and more than that, it can only get rid of sequential commits from latest. I recently happened to get into a scenario where I had to drop a commit in the history by keeping the latest ones. As part of that exploration, presenting you this article. /**  *  @disclaimer  * Please read this post fully before executing any command. My scenario might not be same as yours. */ To my greatest surprise, I didn't know a git rebase could do this. Please continue to read to know how. The steps are simple, Count until the commit line you need to drop using git log Do an interactive rebase and you're done.  Let me explain step by step. 1. Look at the commit log & count commits This is the first step. First let's list the commits using the following command,