Skip to main content

Git magic - Squash commits

Published on

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!

Labels:

Comments

Post a Comment

Popular posts from this blog

Git worktree - guide to flexible folder structure

Published on
As always, let's start with a story why I have written this one down. I have been using git for almost 5 years now and in one of my work places I had to work on the same project but different features in parallel.  Switching between branches back and forth was a costly operation given that I didn't discover commit amend until recently. Even though I'd have discovered commit amend, I'd still have did this. Still did what? I can sense that question deep from your throats. So, whenever I am in a situation to work on multiple features or a feature and a bug fix, I'd have two clones of my repo each with different branches, Whenever a feature is merged or the fixes are merged, I'll delete the clone in my machine and branch in my origin (Gitlab / Github etc.,) Recently when I started writing these git articles, my manager suggested me to learn about Git Worktree and it'll be useful. And when I got free and good understanding of git commit, rebase and stuff, I decid...
Post a Comment
Read more

npm-link | What NPM won't tell you!

Published on
Hello readers. So back with another easy yet unexplored feature of npm/yarn packages. We as frontend developers / SDK developers, have to deal with more than one repositories where we actually code contribute. Most SDK developers would know this already or they use the not-so-well documented 'npm link' command . /**  *  @disclaimer  * Please read this post fully before executing any command. My scenario might not be the same as yours.  * This article below uses a repo from my current workplace as an example which is open-source and does not violate the Cisco Confidentiality Policies */ To make this article easier to understand, some representations, Host - Package that needs another local package as part of its node modules. Let's assume the path to this package is  ~/Documents/Repos/demo-app Adhoc - Local package that is added into another package as a dependency. Let's assume the path to this package is  ~/Documents/Repos/semver-monorepo What is...
Post a Comment
Read more

Building AI Apps - The basics you need to know

Published on
So you want to build an AI assistant? Maybe for customer support, maybe to search through documents, or maybe just to automate some boring stuff at work. You keep hearing words like "prompting", "RAG", "fine-tuning" thrown around in meetings. But what do they actually mean and which one do you need? Let me walk you through building a customer support AI assistant and show you how each of these concepts fits in. /**  * @disclaimer  * This is an educational post based on my learnings.  * I'll share actual experiments in future posts.  * Your use case might be different, so take what applies to you. */ What even is an LLM? Before we jump into the techniques, let's start with the basics. What is an LLM? Think of a Large Language Model (LLM) as someone who has read most of the internet but has zero memory of your conversation once it ends. Models like GPT-4, Claude, or Llama have been trained on massive amounts of text data. They know a lot...
1 comment
Read more