Skip to content

Instantly share code, notes, and snippets.

@jeromesun14
Forked from myusuf3/delete_git_submodule.md
Last active November 1, 2018 01:22
Show Gist options
  • Save jeromesun14/37b992082bfadad460c499e98443311e to your computer and use it in GitHub Desktop.
Save jeromesun14/37b992082bfadad460c499e98443311e to your computer and use it in GitHub Desktop.
How effectively delete a git submodule.

To remove a submodule you need to:

  • Delete the relevant section from the .gitmodules file.
  • Stage the .gitmodules changes git add .gitmodules
  • Delete the relevant section from .git/config.
  • Run git rm --cached path_to_submodule (no trailing slash).
  • Run rm -rf .git/modules/path_to_submodule (no trailing slash).
  • Commit git commit -m "Removed submodule "
  • Delete the now untracked submodule files rm -rf path_to_submodule

To change url of a submodule:

  • modify .gitmodules, change the url. And this can be replaced by the following two commands, stackoverflow:
  • git submodule sync
  • git submodule update --init --recursive --remote
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment