Removing submodules in Git - Mini Project: Build & Apply

Removing Git Submodules Safely

📖 Scenario: You have a Git project that includes a submodule. Now, you want to remove this submodule cleanly from your project to keep your repository tidy and avoid confusion.

🎯 Goal: Learn how to remove a Git submodule step-by-step by updating configuration files and cleaning up the repository.

📋 What You'll Learn

Identify the submodule path in the .gitmodules file

Remove the submodule entry from the Git configuration

Delete the submodule directory from the working tree

Commit the changes to finalize submodule removal

💡 Why This Matters

🌍 Real World

Removing unused or deprecated submodules keeps your Git repository clean and reduces confusion for collaborators.

💼 Career

Understanding submodule management is important for developers and DevOps engineers working with large projects that use Git submodules.

1

Identify the submodule in .gitmodules

Open the .gitmodules file and create a variable called submodule_path with the exact value libs/mylib which is the path of the submodule to remove.

Git

# Create a variable called submodule_path with the value 'libs/mylib'
# Your code here

Hint

The submodule path is the folder name where the submodule is located, for example libs/mylib.

2

Remove submodule entry from Git config

Write a command string called remove_config_cmd that uses git config --remove-section submodule.libs/mylib to remove the submodule configuration.

Git

submodule_path = 'libs/mylib'
# Create a command string remove_config_cmd to remove the submodule config
# Your code here

Hint

The command removes the submodule section from Git config using the submodule path.

3

Delete the submodule directory and update Git index

Write two commands: remove_submodule_dir to delete the directory libs/mylib using rm -rf libs/mylib, and remove_git_index to remove the submodule from Git index using git rm --cached libs/mylib.

Git

submodule_path = 'libs/mylib'
remove_config_cmd = 'git config --remove-section submodule.libs/mylib'
# Create remove_submodule_dir command to delete the submodule directory
# Create remove_git_index command to remove submodule from Git index
# Your code here

Hint

Use rm -rf to delete the folder and git rm --cached to remove it from Git tracking.

4

Commit the submodule removal

Write a command string called commit_cmd that commits the changes with the message "Remove submodule libs/mylib" using git commit -m "Remove submodule libs/mylib". Then print this command.

Git

submodule_path = 'libs/mylib'
remove_config_cmd = 'git config --remove-section submodule.libs/mylib'
remove_submodule_dir = 'rm -rf libs/mylib'
remove_git_index = 'git rm --cached libs/mylib'
# Create commit_cmd to commit the removal with message
# Print the commit_cmd
# Your code here

Hint

Use git commit -m with the exact message and print the command string.

Practice

1. What is the first step to remove a Git submodule from your project?

easy

A. Commit the changes immediately

B. Delete the submodule folder manually

C. Unregister the submodule using git submodule deinit

D. Run git rm --cached on the main repository

Solution

1. Step 1: Unregister the submodule

   Use git submodule deinit <path> to unregister the submodule from Git's configuration.

2. Step 2: Remove submodule files and commit

   After unregistering, delete the submodule folder and commit the changes to keep the project clean.

3. Final Answer:

   Unregister the submodule using git submodule deinit -> Option C

4. Quick Check:

   First step is unregistering submodule [OK]

Hint: Always unregister submodule before deleting files [OK]

Common Mistakes:

• Deleting folder before unregistering causes errors
• Committing before unregistering submodule
• Skipping unregister step

2. Which command correctly removes a submodule's cached entry from Git's index?

easy

A. git rm <submodule_path>

B. git delete submodule <submodule_path>

C. git submodule remove <submodule_path>

D. git rm --cached <submodule_path>

Solution

1. Step 1: Remove cached submodule entry

   Use git rm --cached <submodule_path> to remove the submodule from Git's index without deleting files immediately.

2. Step 2: Delete submodule folder and commit

   After removing cached entry, delete the folder manually and commit the changes.

3. Final Answer:

   git rm --cached <submodule_path> -> Option D

4. Quick Check:

   Remove cached entry with git rm --cached [OK]

Hint: Use --cached to remove from index but keep files temporarily [OK]

Common Mistakes:

• Using git rm without --cached deletes files immediately
• Using non-existent git submodule remove command
• Trying git delete submodule which is invalid

3. Given these commands run in order, what is the final state of the submodule folder?

git submodule deinit mysub
rm -rf .git/modules/mysub
git rm --cached mysub
rm -rf mysub
git commit -m "Remove submodule"

medium

A. The submodule folder and Git data are fully removed

B. The submodule folder remains but is untracked

C. Only Git data is removed, folder remains

D. Submodule is still registered and tracked

Solution

1. Step 1: Unregister and remove Git data

   git submodule deinit mysub unregisters the submodule, and rm -rf .git/modules/mysub deletes its Git data.

2. Step 2: Remove cached index and folder, then commit

   git rm --cached mysub removes it from Git index, rm -rf mysub deletes the folder, and commit saves changes.

3. Final Answer:

   The submodule folder and Git data are fully removed -> Option A

4. Quick Check:

   All steps done means full removal [OK]

Hint: Deinit, remove Git data, rm cached, delete folder, commit [OK]

Common Mistakes:

• Forgetting to delete .git/modules data
• Not committing after removal
• Deleting folder before unregistering

4. You ran rm -rf mysub before git submodule deinit mysub. What problem might occur?

medium

A. Git still tracks the submodule and shows errors on next fetch

B. The submodule folder is restored automatically

C. Git removes the submodule automatically without errors

D. No problem, this is the correct order

Solution

1. Step 1: Understand order importance

   Deleting the folder before unregistering leaves Git still tracking the submodule path.

2. Step 2: Resulting error state

   Git will show errors or warnings because the submodule is missing but still registered.

3. Final Answer:

   Git still tracks the submodule and shows errors on next fetch -> Option A

4. Quick Check:

   Delete folder before deinit causes tracking errors [OK]

Hint: Always deinit before deleting submodule folder [OK]

Common Mistakes:

• Deleting folder first then deinit
• Ignoring Git errors after removal
• Assuming folder deletion unregisters submodule

5. You want to completely remove a submodule named libs/toolkit from your project. Which sequence of commands correctly removes it and cleans all related data?

hard

A. git rm libs/toolkit; rm -rf libs/toolkit; git commit -m "Remove submodule"

B. git submodule deinit libs/toolkit; rm -rf .git/modules/libs/toolkit; git rm --cached libs/toolkit; rm -rf libs/toolkit; git commit -m "Remove submodule"

C. rm -rf libs/toolkit; git submodule deinit libs/toolkit; git commit -m "Remove submodule"

D. git submodule remove libs/toolkit; git commit -m "Remove submodule"

Solution

1. Step 1: Unregister and remove Git submodule data

   Run git submodule deinit libs/toolkit to unregister, then delete Git metadata with rm -rf .git/modules/libs/toolkit.

2. Step 2: Remove cached index and folder, then commit

   Use git rm --cached libs/toolkit to remove from index, delete the folder manually, and commit changes.

3. Final Answer:

   git submodule deinit libs/toolkit; rm -rf .git/modules/libs/toolkit; git rm --cached libs/toolkit; rm -rf libs/toolkit; git commit -m "Remove submodule" -> Option B

4. Quick Check:

   Full removal requires unregister, delete Git data, rm cached, delete folder, commit [OK]

Hint: Deinit, delete .git/modules, rm cached, delete folder, commit [OK]

Common Mistakes:

• Skipping removal of .git/modules data
• Using non-existent git submodule remove command
• Deleting folder before unregistering