↓ Skip to main content
Git Remove Submodule
  1. Posts/

Git Remove Submodule

·1 min·
Operations & Troubleshooting Git How-To Quick-Fix
Aiden Arnkels-Webb
Author
Aiden Arnkels-Webb
I’m a cybersecurity lead and fractional CISO/CTO helping professional services firms build secure, scalable infrastructure. I share practical solutions and strategic insights on this site—all free, no gatekeeping. For done-with-you or done-for-you implementation, I work with firms through Rootwire.

Submodules aren’t removed using git rm submodule-dir, they need to be removed in a far more thorough and annoying fashion. There are a number of unclear explanations at various sources so I decided to write my own findings.

  1. Delete the relevant parts from the .gitmodules file.

    EG:

    [submodule "blog/themes/PaperMod"]
    path = blog/themes/PaperMod
    url = https://github.com/adityatelange/hugo-PaperMod.git

  2. Stage .gitmodules via git add .gitmodules

  3. Remove the relevant parts from .git/config

    EG:

    [submodule "blog/themes/PaperMod"]
    url = https://github.com/adityatelange/hugo-PaperMod.git

  4. Clear the cache with git rm --cached /path/to/submodule - with no trailing slash. Including the trailing slash will throw an error

  5. Remove the .git modules submodule data by running rm -rf .git/modules/submodule_name or rm -rf .git/modules/submodulefoldername

  6. Commit the changes

  7. Delete the submodule files rm -rf path/to/submodule

Related