Skip to content

Instantly share code, notes, and snippets.

@cainmagi
Forked from myusuf3/delete_git_submodule.md
Last active December 20, 2022 19:41
Show Gist options
  • Save cainmagi/1d1ef4d2eec2382e12982950dba7ab15 to your computer and use it in GitHub Desktop.
Save cainmagi/1d1ef4d2eec2382e12982950dba7ab15 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 <name>"
  • Delete the now untracked submodule files rm -rf path_to_submodule

Only two steps are required:

  • Add all not-stanged changes, and commit these changes.
    git commit -a -m "This is the first line." -m "This is the second line."
  • Push the commit to remote
    git push
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment