In Git, submodules allow you to include or embed one or more repositories as a sub-folder inside another repository. This is particularly useful when you want to include libraries or other projects, maintaining their original repository link. Sometimes, you might want to pin a submodule to a particular branch, tag, or commit. In this Answer, we'll explore specifying a branch or tag when adding a Git submodule.
A Git submodule is like a Git repository inside another Git repository that allows you to keep a Git repository as a subdirectory of another Git repository. This is useful when you want to include external libraries or projects in your project while keeping track of their updates.
To add a submodule and specify a branch, use the following command:
git submodule add -b <branch_name> <repository_url> <path/to/submodule>
Replace <branch_name> with the name of the branch, <repository_url> with the URL of the submodule repository, and <path/to/submodule> with the path where you want to place the submodule in your main project.
Suppose you want to add a submodule from a repository https://github.com/example/repo.git and pin it to the dev branch. You'd use:
git submodule add -b dev https://github.com/example/repo.git path/to/submodule
If you want to pin your submodule to a specific tag or commit, the process involves two steps:
Add the submodule:
First, add the submodule without specifying a branch:
git submodule add <repository_url> <path/to/submodule>
Checkout the specific tag or commit:
Navigate to the submodule directory and checkout the desired tag or commit:
cd <path/to/submodule>git checkout <tag_or_commit_sha>
Then, go back to your main project directory and commit the changes:
cd ..git commit -am "Pinned submodule to specific tag/commit"
Remember, if the branch of your submodule has new commits, you need to update the submodule:
git submodule update --remote
This command fetches the latest changes from the submodule branch you've specified. If you've pinned your submodule to a specific commit or tag, you won't see any changes unless you decide to change the pinned reference.
Stay updated: If you're working with branches in submodules, regularly pull updates to ensure you have the latest changes from the upstream branch.
Commit carefully: When you update submodules, remember that you're changing the commit SHAs. Ensure you commit these changes to your main repository to keep everything in sync.
Nested submodules: Git supports nested submodules (a submodule inside another). If adding these, remember to initialize and update them recursively using git submodule update --init --recursive.
Git submodules are a powerful feature, allowing you to seamlessly integrate external projects and libraries. By specifying branches, tags, or commits, you can have fine-grained control over the versions of these submodules. Whether you're maintaining a library or just using one, understanding how to manage submodules effectively can be valuable in your Git toolkit.
Free Resources