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

Confluence: 5 quick things that you need

Published on
As part of my work experiments, this week I would like to write down the things that one needs to know in confluence that can up-skill their documentation works. I will cover the following 5 things, How to Anchor link a title? How to Anchor link to a section? How to create a dashing dashboard? Panel - Confluence Macro Layouts - Confluence Tools Content by Label - Confluence Macro 1. How to Anchor link a title? This is the most required thing. Most useful when one has to refer to a section internally on the same confluence page. Let's consider you have a page with three different sections and titles as shown below, In this, if you want to add an internal anchor from a text in paragraph 3 to a title in paragraph 1, you can add it as follows, Choose the word that needs Anchor Click on the link icon from the Toolbar above In the link box, enter #Page Title 1 Click Insert That is it. Your anchor from the selected text to Page Title 1 is ready. This can be tested out in the preview itsel
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 npm link? This is a co
Post a Comment
Read more