Skip to content

Instantly share code, notes, and snippets.

@steverichey

steverichey/delete_git_submodule.md

Forked from myusuf3/delete_git_submodule.md
Last active January 26, 2021 14:43
Show Gist options
  • Save steverichey/68ad3353b39bb7ae65721f6b504b5b9b to your computer and use it in GitHub Desktop.
Save steverichey/68ad3353b39bb7ae65721f6b504b5b9b to your computer and use it in GitHub Desktop.
Download ZIP
How to effectively delete a git submodule.
Raw
delete_git_submodule.md

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 <name>"
  • Delete the now untracked submodule files: rm -rf path/to/submodule
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment