Summary - Submodule

Combine the submodule flow to manage an embedded repo.

Summary: Submodule workflow

A submodule lets you use an independent Git repository inside another project. Use git submodule add with a repository URL and target directory to add it. The parent repository stores a reference to a specific submodule commit.

git submodule add https://github.com/example/shared.git vendor/shared

After cloning the project, use git submodule update --init --recursive to prepare submodules and nested submodules.

Exercise Complete the submodule workflow

Add https://github.com/example/chart-kit.git as a submodule at vendor/chart-kit. Then initialize and update all submodules in the parent project, including nested submodules.

Show example solution

git submodule add https://github.com/example/chart-kit.git vendor/chart-kit
git submodule update --init --recursive

Test yourself

A teammate who cloned the parent project needs to prepare nested submodules as well. Which command performs the required initialization and update operations?
- git submodule status --recursive
- git submodule update --init --recursive
- git submodule add --recursive
- git submodule reset --recursive
Show answer

git submodule update --init --recursive — update --init --recursive initializes submodules and updates nested submodules as well.

Complete the submodule addition command

git submodule add https://github.com/example/theme.git ____

Show answer

git submodule add https://github.com/example/theme.git resources/theme

Submodule workflow

submodule add

Adds a new nested repository
URL

Specifies the nested repository address
--init

Initializes submodule settings
--recursive

Prepares nested repositories too

Next lesson: git worktree

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies