Git Submodules入門

What are Git Submodules? They let you embed one Git repository inside another as a sub-directory. It's like having a separate project living inside your main project, but still managed independently.

Imagine your project needs a specific library or component that's developed and maintained separately. Instead of copying its code, you can use a submodule.

• Vendor Code: Include third-party libraries.
• Shared Components: Reusable code across multiple projects.
• Plugin Systems: Modularize parts of a larger application.

A submodule isn't just a folder of files. It's a pointer to a specific commit in another Git repository. Your main project tracks which commit of the submodule it should use.

This means your main project doesn't directly manage the submodule's content, but rather its reference.

Git stores submodules as a special entry in your main repository's index. It records the submodule's path, the URL of its remote repository, and the specific commit hash it currently points to.

When you clone a project with submodules, you'll initially see empty directories until you initialize and update them.

Each submodule is its own standalone Git repository. You can clone it, switch branches, commit changes, and push them, all independently of the parent repository.

This isolation is key to managing external dependencies without merging their history into your main project.

Submodules are excellent for:

• Stable Dependencies: When you need a specific version of an external library and don't want it to change unexpectedly.
• Large Components: Breaking down a monolithic project into smaller, manageable, independently versioned parts.
• Open-Source Contributions: Integrating external tools or frameworks without maintaining their source directly.

They are particularly useful when:

• You need to track a specific version of a dependency, not just the latest.
• The dependency is managed by a different team or project.
• You want to keep the dependency's history separate from your main project's history.

When you add a submodule, Git creates a special configuration file at the root of your main repository: .gitmodules.

This file stores the mapping between the submodule's local path and its remote URL. It's version-controlled, so everyone cloning your project knows about its submodules.

While submodules are great, they have alternatives. One notable option is Git Subtree.

Submodules keep the dependency's history separate, while Git Subtree integrates the dependency's history directly into your main repository. We'll explore Subtree in a later lesson!

Let's check your understanding of Git submodules.

We've introduced Git submodules, understanding them as a way to embed independent Git repositories within your main project.

• They track specific commits of external repos.
• They solve problems of shared code and stable dependencies.
• They are configured via the .gitmodules file.

Next, we'll learn how to add and clone submodules.