Is there some easy way to rename a git submodule directory (other than going through the entire motion of deleting it and re-adding it with a new destination name).
And while we are at it, why is it that I simply cannot do the following in the parent directory: git mv old-submodule-name new-submodule-name
I found following workflow working:
mv oldpath newpathgit rm oldpathgit add newpathgit submodule syncNote: this approach does not update the index and .gitmodules properly in 2018 versions of GIT.
Note: You may be able to just do git mv oldpath newpath now, as pointed out in VonC's answer. (Ensure you are using the latest version of git)
git add newpath don't use a trailing slash –
Goldfinch fatal: This operation must be run in a work tree fatal: 'git status --porcelain' failed in submodule newpath. I used git submodule add SUB_URL new_path instead of git add new_path, and it worked. –
Substantive .git/modules/SUBMODULE/config file, such that the worktree points to the the right directory again. –
Paulin 2.13.1. But simply doing git mv old new works like a charm. I only need to do git commit to complete the changes. –
Feliks .gitmodules so it doesn't really work. –
Antiquary Git1.8.5 (October 2013) should simplify the process. Simply do a:
git mv A B
"
git mv A B", when moving a submoduleAhas been taught to relocate its working tree and to adjust the paths in the.gitmodulesfile.
See more in commit 0656781fadca1:
Currently using "
git mv" on a submodule moves the submodule's work tree in that of the superproject. But the submodule's path setting in.gitmodulesis left untouched, which is now inconsistent with the work tree and makes git commands that rely on the properpath -> name mapping(likestatusanddiff) behave strangely.Let "
git mv" help here by not only moving the submodule's work tree but also updating the "submodule.<submodule name>.path" setting from the.gitmodulesfile and stage both.
This doesn't happen when no.gitmodulesfile is found and only issues a warning when it doesn't have a section for this submodule. This is because the user might just use plain gitlinks without the.gitmodulesfile or has already updated the path setting by hand before issuing the "git mv" command (in which case the warning reminds him thatmvwould have done that for him).
Only when.gitmodulesis found and contains merge conflicts themvcommand will fail and tell the user to resolve the conflict before trying again.
git 2.9 (June 2016) will improve git mv for submodule:
See commit a127331 (19 Apr 2016) by Stefan Beller (stefanbeller).
(Merged by Junio C Hamano -- gitster -- in commit 9cb50a3, 29 Apr 2016)
mv: allow moving nested submodules"
git mv old new" did not adjust the path for a submodule that lives as a subdirectory insideold/directory correctly.submodules however need to update their link to the git directory as well as updates to the
.gitmodulesfile.
.gitmodules contains no absolute path information. However {submodule}/.git and .git/modules/submodules/{submodule}/config does, and this is updated correctly for the first-level submodules but not the second-level submodules, when a first-level submodule is moved within the parent repo. I had to update both of the second-level submodule files manually for git status and other commands to work again. git submodule sync doesn't fix it, although --recursive might (although I forgot to try.) –
Amylo git submodule update --recursive --init done from the main parent repo fix those automatically after the git mv? –
Cuddle git mv folder newpathor git mv folder/ newpath/?) –
Cuddle I found following workflow working:
mv oldpath newpathgit rm oldpathgit add newpathgit submodule syncNote: this approach does not update the index and .gitmodules properly in 2018 versions of GIT.
Note: You may be able to just do git mv oldpath newpath now, as pointed out in VonC's answer. (Ensure you are using the latest version of git)
git add newpath don't use a trailing slash –
Goldfinch fatal: This operation must be run in a work tree fatal: 'git status --porcelain' failed in submodule newpath. I used git submodule add SUB_URL new_path instead of git add new_path, and it worked. –
Substantive .git/modules/SUBMODULE/config file, such that the worktree points to the the right directory again. –
Paulin 2.13.1. But simply doing git mv old new works like a charm. I only need to do git commit to complete the changes. –
Feliks .gitmodules so it doesn't really work. –
Antiquary The correct solution is:
mv oldpath ~/another-location
git rm oldpath
git submodule add submodule-repository-URL newpath
It's not possible to rename it, so you've to remove it first (deinit) and add it again.
So after removing it:
git submodule deinit <path>
git rm --cached <path>
you may also double check and remove the references to it in:
.gitmodules.git/config.git/modules/<name> (best to make a backup), as each folder has config file where it keeps the reference to its worktreethen stage your changes by committing any changes to your repo by:
git commit -am 'Removing submodule.'
and double check if you don't have any outstanding issues by:
git submodule update
git submodule sync
git submodule status
so now you can add the git submodule again:
git submodule add --name <custom_name> [email protected]:foo/bar.git <my/path>
I just tried a few of the suggested above. I'm running:
$ git --version
git version 1.8.4
I found it was best to de-init the submodule, remove the directory and create a new submodule.
git submodule deinit <submodule name>
git rm <submodule folder name>
git submodule add <address to remote git repo> <new folder name>
At least that is what worked for me best. YMMV!
MacOs: When I wanna use VonC solution to change submodule folder Common to lowercase:
git mv Common common
I get
fatal: renaming 'Common' failed: Invalid argument
Solution - use some temporary folder name and move twice:
git mv Common commontemp
git mv commontemp common
That's all :)
Edit the .gitmodules file to rename the submodule and then rename the submodule directory.
I think you might need to do a git submodule sync afterwards, but I'm not in a position to check right now.
© 2022 - 2024 — McMap. All rights reserved.
.gitmodulesmanually when moving a submodule. see my answer below – Cuddlenpmshows how simple works. One day... maybe... someone... will rewrite it... in the meantime... – Antiquary