Skip to main content

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,

  1. Remove a newly added file
  2. 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. Remove your file from the local folder

Go to the root folder of your repository and execute the below command,

    > rm config.json

2. Stage and amend the commit

    > git add config.json
    > git commit --amend

Remove changes to an existing file

This is tricky but easy-to-solve scenario once you know it's doable. This is the scenario where there's a file already in the branch and you made some accidental changes to it and committed it. To remove the accidental changes and put it back to what it was before,

1. Checkout the file from the parent branch

Let's say you have made changes to webpack.config.js but don't need that change anymore and let's assume you are working in a branch that was created from an upstream/main branch.

Go to the root folder of your repository and execute the below command,

    > git checkout upstream/main -- webpack.config.js

2. Stage and commit

    > git add config.json
    > git commit --amend

Tada! With this, we come to an end of this git flow. If there's anything that you might want me to add or discuss or if there's anything I've missed, please leave comments below.

Comments

Popular posts from this blog

Confluence: 5 quick things that you need

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

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

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

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 bee