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

Need a 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

Need a 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

Need a 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

Need a hint?

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