Skip to content

Instantly share code, notes, and snippets.

@serrasqueiro
Forked from myusuf3/delete_git_submodule.md
Last active July 23, 2023 12:03
Show Gist options
  • Save serrasqueiro/3f1ff4f213a049afc624283aac7197fb to your computer and use it in GitHub Desktop.
Save serrasqueiro/3f1ff4f213a049afc624283aac7197fb to your computer and use it in GitHub Desktop.
How effectively delete a git submodule.

To remove a submodule you need to:

  1. Delete the relevant section from the .gitmodules file.
  2. Stage the .gitmodules changes: git add .gitmodules
  3. Delete the relevant section from .git/config
  4. Run git rm --cached path_to_submodule (no trailing slash)
  5. Run rm -rf .git/modules/path_to_submodule (no trailing slash)
  6. Commit: git commit -m "Removed submodule <name>"
  7. 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