freeCodeCamp/guide/english/miscellaneous/how-to-remove-a-submodule-i.../index.md

967 B

title
How to Remove a Submodule in Git

Removing a submodule is useful when it is no longer required. The steps below outline the removal of a submodule.

Remove Submodule

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

Sources