Why submodules manage nested repos in Git - See It in Action

Why Submodules Manage Nested Repos

📖 Scenario: Imagine you have a main project that uses another project inside it. This other project is a separate repository. You want to keep them connected but separate, like having a toolbox inside your main toolbox.

🎯 Goal: You will learn how to add a nested repository inside a main repository using Git submodules. This helps manage projects inside projects clearly and safely.

📋 What You'll Learn

Create a main Git repository

Add a nested Git repository as a submodule

Check the submodule status

Display the list of submodules

💡 Why This Matters

🌍 Real World

Many projects depend on other projects. Using submodules helps keep these dependencies organized and separate, like having smaller toolkits inside a big toolbox.

💼 Career

Understanding Git submodules is important for developers and DevOps engineers to manage complex projects with multiple repositories efficiently.

1

Create the main Git repository

Create a new directory called main_project and initialize it as a Git repository using git init.

Git

# Create a directory named main_project and initialize it as a Git repo
# Your code here

Hint

Use mkdir to make a folder, cd to enter it, and git init to start a Git repo.

2

Add a nested Git repository as a submodule

Inside main_project, add a submodule named nested_repo from the URL https://github.com/example/nested_repo.git using git submodule add.

Git

mkdir main_project
cd main_project
git init
# Add the nested_repo submodule from the given URL
# Your code here

Hint

Use git submodule add <URL> <folder_name> to add the nested repo.

3

Check the submodule status

Use git submodule status inside main_project to see the current state of the submodule.

Git

mkdir main_project
cd main_project
git init
git submodule add https://github.com/example/nested_repo.git nested_repo
# Check the submodule status
# Your code here

Hint

Run git submodule status to see the submodule commit and path.

4

Display the list of submodules

Use git config --file .gitmodules --name-only --get-regexp path to list the paths of all submodules in main_project.

Git

mkdir main_project
cd main_project
git init
git submodule add https://github.com/example/nested_repo.git nested_repo
git submodule status
# List all submodule paths
# Your code here

Hint

This command reads the .gitmodules file to show submodule paths.

Practice

1. Why do Git submodules help when you want to include another repository inside your project?

easy

A. They merge the nested repository's history into the main project.

B. They keep the nested repository separate with its own history.

C. They copy all files from the nested repository permanently.

D. They delete the nested repository after adding it.

Solution

1. Step 1: Understand submodule purpose

   Git submodules allow you to include another repository inside your project but keep it separate.

2. Step 2: Recognize history separation

   This means the nested repo keeps its own commit history and does not merge with the main project.

3. Final Answer:

   They keep the nested repository separate with its own history. -> Option B

4. Quick Check:

   Submodules keep histories separate = A [OK]

Hint: Submodules keep nested repos separate, not merged [OK]

Common Mistakes:

• Thinking submodules merge histories
• Assuming submodules copy files permanently
• Believing submodules delete nested repos

2. Which command correctly adds a Git submodule to your project?

easy

A. git submodule add https://github.com/example/repo.git

B. git add submodule https://github.com/example/repo.git

C. git clone submodule https://github.com/example/repo.git

D. git submodule clone https://github.com/example/repo.git

Solution

1. Step 1: Recall submodule add syntax

   The correct command to add a submodule is git submodule add <repo-url>.

2. Step 2: Check options for correct syntax

   Only git submodule add https://github.com/example/repo.git matches this syntax exactly.

3. Final Answer:

   git submodule add https://github.com/example/repo.git -> Option A

4. Quick Check:

   Use 'git submodule add' to add submodules = C [OK]

Hint: Add submodules with 'git submodule add' command [OK]

Common Mistakes:

• Using 'git add submodule' which is invalid
• Trying 'git clone submodule' which is not a command
• Confusing 'git submodule clone' which doesn't exist

3. What is the output of running git submodule update --init after cloning a repository with submodules?

medium

A. It lists all submodules without downloading them.

B. It deletes all submodule directories from the project.

C. It fetches and checks out the submodule repositories at the recorded commit.

D. It merges submodule commits into the main repository.

Solution

1. Step 1: Understand 'git submodule update --init'

   This command downloads the submodule repositories and checks out the commit recorded in the main repo.

2. Step 2: Compare options with command behavior

   Only It fetches and checks out the submodule repositories at the recorded commit. correctly describes this behavior; others describe incorrect actions.

3. Final Answer:

   It fetches and checks out the submodule repositories at the recorded commit. -> Option C

4. Quick Check:

   'git submodule update --init' fetches submodules = D [OK]

Hint: Update and initialize submodules with 'git submodule update --init' [OK]

Common Mistakes:

• Thinking it deletes submodules
• Assuming it merges submodule commits
• Believing it only lists submodules

4. You cloned a repository with submodules but forgot to run git submodule update --init. What problem will you face?

medium

A. The submodule folders will be empty or missing files.

B. The main repository will not clone properly.

C. The submodules will automatically update without any command.

D. The repository will merge submodule commits automatically.

Solution

1. Step 1: Understand cloning with submodules

   When cloning, submodule folders exist but are empty until you initialize and update them.

2. Step 2: Identify the effect of missing update

   Without running git submodule update --init, submodule content is not fetched, so folders are empty or incomplete.

3. Final Answer:

   The submodule folders will be empty or missing files. -> Option A

4. Quick Check:

   Missing 'git submodule update --init' causes empty submodule folders = B [OK]

Hint: Always run 'git submodule update --init' after cloning repos with submodules [OK]

Common Mistakes:

• Expecting submodules to auto-update
• Thinking main repo cloning fails
• Assuming submodules merge automatically

5. You want to update a submodule to a newer commit and push this change to the main repository. Which sequence of commands is correct?

hard

A. cd submodule_dir; git pull; git merge main; git push

B. git submodule update --init; git commit -m 'Update submodule'; git push

C. git clone submodule_dir; git push; git commit -m 'Update submodule'

D. cd submodule_dir; git checkout new_commit; cd ..; git add submodule_dir; git commit -m 'Update submodule'; git push

Solution

1. Step 1: Update submodule commit

   Navigate into the submodule directory and checkout the desired new commit.

2. Step 2: Stage and commit submodule change in main repo

   Return to main repo, add the submodule directory change, commit with a message, then push.

3. Final Answer:

   cd submodule_dir; git checkout new_commit; cd ..; git add submodule_dir; git commit -m 'Update submodule'; git push -> Option D

4. Quick Check:

   Update submodule commit then commit in main repo = A [OK]

Hint: Update submodule inside folder, then commit main repo change [OK]

Common Mistakes:

• Trying to update submodule without committing main repo
• Running 'git submodule update --init' instead of checkout
• Confusing clone with update commands