Handling file renames in Git

Question

I'd read that when renaming files in Git, you should commit any changes, perform your rename and then stage your renamed file. Git will recognise the file from the contents, rather than seeing it as a new untracked file, and keep the change history.

However, doing just this tonight I ended up reverting to git mv.

> $ git status
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#    modified:   index.html
#

I renamed my stylesheet in Finder from iphone.css to mobile.css:

> $ git status
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#    modified:   index.html
#
# Changed but not updated:
#   (use "git add/rm <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#    deleted:    css/iphone.css
#
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#    css/mobile.css

So Git now thinks I've deleted one CSS file, and added a new one. It is not what I want. Let’s undo the rename and let Git do the work.

> $ git reset HEAD .
Unstaged changes after reset:
M    css/iphone.css
M    index.html

I am back to where I began:

> $ git status
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#    modified:   index.html
#

Let's use git mv instead:

> $ git mv css/iphone.css css/mobile.css
> $ git status
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#    renamed:    css/iphone.css -> css/mobile.css
#
# Changed but not updated:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#    modified:   index.html
#

It looks like we're good. So why didn't Git recognise the rename the first time around when I used Finder?

Answer 1

For git mv the manual page says

The index is updated after successful completion, […]

So, at first, you have to update the index on your own (by using git add mobile.css). However git status will still show two different files:

$ git status
# On branch master
warning: LF will be replaced by CRLF in index.html
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#       modified:   index.html
#       new file:   mobile.css
#
# Changed but not updated:
#   (use "git add/rm <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#       deleted:    iphone.css
#

You can get a different output by running git commit --dry-run -a, which results in what you expect:

Tanascius@H181 /d/temp/blo (master)
$ git commit --dry-run -a
# On branch master
warning: LF will be replaced by CRLF in index.html
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#       modified:   index.html
#       renamed:    iphone.css -> mobile.css
#

I can't tell you exactly why we see these differences between git status and git commit --dry-run -a, but here is a hint from Linus:

git really doesn't even care about the whole "rename detection" internally, and any commits you have done with renames are totally independent of the heuristics we then use to show the renames.

A dry-run uses the real renaming mechanisms, while a git status probably doesn't.

Answer 2

You have to add the two modified files to the index before Git will recognize it as a move.

The only difference between mv old new and git mv old new is that the git mv also adds the files to the index.

mv old new then git add -A would have worked, too.

Note that you can't just use git add ., because that doesn't add removals to the index.

See Difference between "git add -A" and "git add ."

Answer 3

For Git 1.7.x the following commands worked for me:

git mv css/iphone.css css/mobile.css
git commit -m 'Rename folder.'

There was no need for git add, since the original file (i.e., css/mobile.css) was already in the committed files previously.

Answer 4

The best thing is to try it for yourself.

mkdir test
cd test
git init
touch aaa.txt
git add .
git commit -a -m "New file"
mv aaa.txt bbb.txt
git add .
git status
git commit --dry-run -a

Now git status and git commit --dry-run -a shows two different results where git status shows bbb.txt as a new file/ aaa.txt is deleted, and the --dry-run commands shows the actual rename.

~/test$ git status

# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#   new file:   bbb.txt
#
# Changes not staged for commit:
#   (use "git add/rm <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#   deleted:    aaa.txt
#


/test$ git commit --dry-run -a

# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#   renamed:    aaa.txt -> bbb.txt
#

Now go ahead and do the check-in.

git commit -a -m "Rename"

Now you can see that the file is in fact renamed, and what's shown in git status is wrong, at least in this case. It might be the case that underline GIT implementation treats the two commands separately.

Moral of the story: If you're not sure whether your file got renamed, issue a "git commit --dry-run -a". If it's showing that the file is renamed, you're good to go.

Answer 5

Step 1: rename the file from oldfile to newfile

git mv #oldfile #newfile

Step 2: git commit and add comments

git commit -m "rename oldfile to newfile"

Step 3: push this change to the remote sever

git push origin #localbranch:#remotebranch

Answer 6

You have to git add css/mobile.css the new file and git rm css/iphone.css, so Git knows about it. Then it will show the same output in git status.

You can see it clearly in the status output (the new name of the file):

# Untracked files:
#   (use "git add <file>..." to include in what will be committed)

And (the old name):

# Changed but not updated:
#   (use "git add/rm <file>..." to update what will be committed)

I think behind the scenes git mv is nothing more than a wrapper script which does exactly that: delete the file from the index and add it under a different name

Answer 7

Let's think about your files from a Git perspective.

Keep in mind Git doesn't track any metadata about your files

Your repository has (among others)

$ cd repo
$ ls
...
iphone.css
...

And it is under Git control:

$ git ls-files --error-unmatch iphone.css &>/dev/null && echo file is tracked
file is tracked

Test this with:

$ touch newfile
$ git ls-files --error-unmatch newfile &>/dev/null && echo file is tracked
(no output, it is not tracked)
$ rm newfile

When you do

$ mv iphone.css mobile.css

From a Git perspective,

• there isn't any iphone.css (it is deleted -git warns about that-).
• there is a new file mobile.css.
• Those files are totally unrelated.

So, Git advises about files it already knows (iphone.css) and new files it detects (mobile.css), but only when files are in index or HEAD, Git starts to check their contents.

At this moment, neither "iphone.css deletion" nor mobile.css are in the index.

Add iphone.css deletion to the index:

$ git rm iphone.css

Git tells you exactly what has happened (iphone.css is deleted. Nothing more happened):

Then add the new file mobile.css:

$ git add mobile.css

This time both deletion and new file are in the index. Now Git detects the context is the same and expose it as a rename. In fact, if files are 50% similar, it will detect that as a rename that lets you change mobile.css a bit while keeping the operation as a rename.

See this is reproducible on git diff. Now that your files are in the index you must use --cached. Edit mobile.css a bit, add that to index, and see the difference between:

$ git diff --cached

and

$ git diff --cached -M

-M is the "detect renames" option for git diff. -M stands for -M50% (50% or more similarity will make Git express it as a rename), but you can reduce this to -M20% (20%) if you edit file mobile.css a lot.

Answer 8

Git will recognise the file from the contents, rather than seeing it as a new untracked file

That's where you went wrong.

It's only after you add the file, that Git will recognize it from the content.

Answer 9

You didn't stage the results of your Finder move. I believe if you did the move via Finder and then did git add css/mobile.css ; git rm css/iphone.css, Git would compute the hash of the new file and only then realize that the hashes of the files match (and thus it's a rename).

Answer 10

In cases where you really have to rename the files manually, for example, using a script to batch rename a bunch of files, then using git add -A . worked for me.

Answer 11

For Xcode users: If you're renaming your file in Xcode you see the badge icon change to append. If you do a commit using Xcode you will actually create a new file and lose the history.

A workaround is easy, but you have to do it before committing using Xcode:

1. Do a Git status on your folder. You should see that the staged changes are correct:

   renamed:    Project/OldName.h -> Project/NewName.h
   renamed:    Project/OldName.m -> Project/NewName.m
   

2. Do commit -m 'name change'

   Then go back to Xcode and you will see the badge changed from A to M and it is saved to commit future changes in using Xcode now.

Answer 12

Just ran into this issue - if you updated a bunch of files and don't want to do git mv all of them this also works:

1. Rename parent directory from /dir/RenamedFile.js to /whatever/RenamedFile.js.
2. git add -A to stage that change
3. Rename parent directory back to /dir/RenamedFile.js.
4. git add -A again, will re-stage vs that change, forcing git to pick up the filename change.

Answer 13

Tested on git 2.33 on Window 10

1. Rename the folders & files you need in Windows Explorer.
2. Run git add .
3. Run git commit -m "commit message"
4. Run git push

Git should detect the renaming operations. You can check by running git status (after committing)

Answer 14

When I capitalised my folders & files I used Node.js' file-system to resolve this problem.

Don'f forget to make a commit before you start. I'm not sure how stable it is :)

1. Create script file in project root.

// File rename.js

const fs = require('fs').promises;
const util = require('util');
const exec = util.promisify(require('child_process').exec);

const args = process.argv.slice(2);
const path = args[0];

const isCapitalized = (s) => s.charAt(0) === s.charAt(0).toUpperCase();

const capitalize = (s) => s.charAt(0).toUpperCase() + s.slice(1);

async function rename(p) {
  const files = await fs.readdir(p, { withFileTypes: true });
  files.forEach(async (file) => {
    const { name } = file;
    const newName = capitalize(name);
    const oldPath = `${p}/${name}`;
    const dumbPath = `${p}/dumb`;
    const newPath = `${p}/${newName}`;
    if (!isCapitalized(name) && name !== 'i18n' && name !== 'README.md') {
      // 'git mv' won't work if we only changed size of letters.
      // That's why we need to rename to dumb name first, then back to current.
      await exec(`git mv ${oldPath} ${dumbPath}`);
      await exec(`git mv ${dumbPath} ${newPath}`);
    }
    if (file.isDirectory()) {
      rename(newPath);
    }
  });
}

rename(path);

To rename all files in directory (or single file) script is simpler:

// rename.js

const fs = require('fs').promises;
const util = require('util');
const exec = util.promisify(require('child_process').exec);
const args = process.argv.slice(2);
const path = args[0];

async function rename(p) {
  const files = await fs.readdir(p, { withFileTypes: true });
  files.forEach(async (file) => {
    const { name } = file;
    const currentPath = `${p}/${name}`;
    const dumbPapth = `${p}/dumb`;
    await exec(`git mv ${currentPath} ${dumbPath}`);
    await exec(`git mv ${dumbPath} ${currentPath}`);
    if (file.isDirectory()) {
      rename(newPath);
    }
  });
}

rename(path);

2. Run the script with arguments

node rename.js ./frontend/apollo/queries

How to run shell script file or command using Node.js