Git Notes
HubBenefits of Git and GitHub - Why They MatterGit vs GitHubVersion Control SystemWhat Is GitWhat Is GitHubConfigure Git - User Identity and SettingsCreate GitHub Account - Sign Up GuideFirst Git Repository - Getting StartedInstall Git on Linux - Complete Setup GuideInstall Git on macOS - Installation GuideInstall Git on Windows - Step-by-Step GuideGit Add - Stage ChangesGit Clone - Copy Remote Repositories LocallyGit Commit - Save ChangesGit Diff - Compare Changes in Your RepositoryGit Ignore - Exclude Files from Version ControlGit Init - Initialize RepositoryGit Log - View Commit HistoryGit Status - Check Repository StateGit Fetch - Download Remote Changes Without MergingGit Pull - Fetch and Merge Remote ChangesGit Push - Upload Local Commits to Remote RepositoryGit Remote - Manage Remote Repository ConnectionsLocal Repository - Understanding Your Git Working EnvironmentRemote Repository - Collaborate Through Shared RepositoriesSync Local and Remote - Keep Repositories in HarmonyAmend Commit - Fix Last CommitDelete Branch - Clean Up BranchesGit Reset - Move HEAD and Undo CommitsGit Restore - Discard ChangesGit Revert - Safely Undo ChangesRecover Lost Commits - Reflog GuideFork RepositoryGitHub PagesGitHub Profile SetupGitHub RepositoriesGitHub Stars and WatchersRepository SettingsCode ReviewsGit CloneGit FetchGit PullGit PushGitHub IssuesLabels and MilestonesOpen Source ContributionsGitHub Project BoardsPull Requests - Propose and Review Code ChangesTeam Collaboration with Git and GitHubAutomated Testing with GitHub ActionsCI/CD with GitHub ActionsDeployment Automation with GitHub ActionsIntroduction to GitHub ActionsGitHub Actions RunnersGitHub Actions WorkflowsEnterprise Git Workflows - Scale Git for Large OrganizationsFeature Branch Workflow - Isolate Development WorkGitFlow Workflow - Structured Release ManagementMonorepo Workflow - Manage Multiple Projects in One RepositoryTrunk-Based Development - Ship Code Fast and SafelyDeployment WorkflowsGitHub Pages DeploymentNetlify Deployment from GitHubRender Deployment from GitHubVercel Deployment from GitHubBranch Protection Rules - Secure Your Git BranchesPersonal Access Tokens - Authenticate with GitHubRepository Security Best PracticesSecret Scanning - Detect Leaked Credentials in CodeSigned Commits - Verify Commit Authenticity with GPGSSH Keys - Secure Git Authentication Without PasswordsGit Bisect - Find Bugs with Binary SearchGit Cherry-Pick - Apply Specific Commits to Any BranchGit Hooks - Automate Workflows with Git EventsGit Internals - Understanding How Git Works Under the HoodGit Stash - Temporarily Save Uncommitted ChangesGit Submodules - Manage External Dependencies as Git ReposGit Tag - Mark Important Points in HistoryGit Worktrees - Work on Multiple Branches SimultaneouslyCollaborative Web App ProjectComplete Team Workflow ProjectGitHub Actions Project - Build a CI/CD PipelineOpen Source Project Contribution - Guided ExercisePortfolio Project with Git - Showcase Your SkillsGit Command CheatsheetGit Interview Questions - Comprehensive Preparation GuideGitHub Interview QuestionsScenario-Based Git Interview QuestionsGit Troubleshooting GuideGit Best Practices - Professional Development HabitsCommon Git Errors and Fixes - Quick SolutionsGit Command Reference - Complete Command GuideLearning Resources - Continue Your Git & GitHub EducationBranch Strategies - Choosing the Right Git Branching ModelCreate Branch in Git - Start New Development LinesFast-Forward Merge in Git - Clean Linear HistoryGit BranchGit CheckoutGit MergeGit RebaseMerge Branches in Git - Combine Development WorkMerge Conflicts - Resolve Git Conflicts Like a ProSwitch Branch in Git - Navigate Between Branches
Learn how to use Git submodules to include external repositories within your project. Cover adding, updating, cloning with submodules, and alternatives.
Git submodules allow you to keep a Git repository as a subdirectory of another Git repository. This is useful for including external libraries, shared components, or any project that has its own development lifecycle.
What Are Submodules?
A submodule is a reference to a specific commit in another repository. Your main repo stores:
- The URL of the submodule repository
- The specific commit SHA to use
- The path where it should be checked out
my-project/
├── .gitmodules # Submodule configuration
├── src/
├── libs/
│ └── shared-utils/ # Submodule (separate repo)
└── vendor/
└── ui-framework/ # Another submodule
Adding a Submodule
bash example
git submodule add https://github.com/org/shared-lib.git libs/shared-libOutput
Cloning into 'libs/shared-lib'... remote: Enumerating objects: 145, done. remote: Total 145 (delta 0), reused 0 (delta 0) Receiving objects: 100% (145/145), done.
This creates/modifies two files:
bash example
cat .gitmodulesOutput
[submodule "libs/shared-lib"]
path = libs/shared-lib
url = https://github.com/org/shared-lib.gitbash example
# The submodule reference is staged
git statusOutput
On branch main
Changes to be committed:
new file: .gitmodules
new file: libs/shared-libbash example
# Commit the submodule addition
git commit -m "Add shared-lib submodule"Cloning a Project with Submodules
Method 1: Clone Then Initialize
bash example
git clone https://github.com/org/my-project.git
cd my-project
# Submodule directories exist but are empty
git submodule init
git submodule updateMethod 2: Clone with --recurse-submodules
bash example
git clone --recurse-submodules https://github.com/org/my-project.gitThis automatically initializes and clones all submodules.
Updating Submodules
Update to the Commit Referenced by Parent
bash example
git submodule updateUpdate to Latest Remote Commit
bash example
# Update all submodules to latest
git submodule update --remote
# Update a specific submodule
git submodule update --remote libs/shared-libOutput
Submodule path 'libs/shared-lib': checked out 'abc1234def567890...'
bash example
# After updating, commit the new reference
git add libs/shared-lib
git commit -m "Update shared-lib to latest version"Pull Changes in Submodule Directly
bash example
cd libs/shared-lib
git pull origin main
cd ../..
git add libs/shared-lib
git commit -m "Update shared-lib submodule"Working Inside Submodules
bash example
# Navigate into submodule
cd libs/shared-lib
# It is a regular Git repo
git log --oneline -5
git branch -a
# Make changes and commit
echo "new feature" >> feature.js
git add . && git commit -m "Add feature"
git push origin main
# Go back to parent and update reference
cd ../..
git add libs/shared-lib
git commit -m "Update shared-lib to include new feature"Removing a Submodule
bash example
# 1. Remove from .gitmodules
git submodule deinit -f libs/shared-lib
# 2. Remove from .git/modules
rm -rf .git/modules/libs/shared-lib
# 3. Remove the working directory
git rm -f libs/shared-lib
# 4. Commit
git commit -m "Remove shared-lib submodule"Submodule Status
bash example
git submodule statusOutput
abc1234def567890 libs/shared-lib (v2.1.0) +def5678abc901234 vendor/ui-framework (v1.3.0-5-gabc1234) -ghi9012def345678 libs/analytics
Prefix meanings:
+: Checked out at a different commit than recorded-: Not initialized
Foreach Command
Run a command in each submodule:
bash example
# Pull latest in all submodules
git submodule foreach git pull origin main
# Check status of all submodules
git submodule foreach git status
# Run custom commands
git submodule foreach 'echo $name: $path ($sha1)'Submodules vs Subtrees
| Feature | Submodules | Subtrees |
|---|---|---|
| External repo reference | ✅ SHA pointer | Merged into tree |
| Clone complexity | Higher (--recurse) | None (included) |
| Contributor experience | Must know submodules | Transparent |
| Independent history | ✅ Separate | Merged into parent |
| Push back changes | ✅ Easy | Possible but complex |
| Disk space | Efficient (on demand) | Always included |
Common Issues and Solutions
Submodule Directory is Empty After Clone
bash example
git submodule init
git submodule updateDetached HEAD in Submodule
Submodules check out specific commits, not branches:
bash example
cd libs/shared-lib
git checkout main # Switch to a branch if neededModified Submodule Showing in Parent Status
Example
# Ignore dirty submodules in status
git config diff.ignoreSubmodules dirty
# Or in .gitmodules:
# [submodule "libs/shared-lib"]
# ignore = dirty
Interview Questions
- What is a Git submodule?
A submodule is a Git repository embedded inside another repository at a specific commit. The parent repo stores a reference (URL + commit SHA) to the submodule, allowing you to include external code with its own version history.
- How do you clone a repository that contains submodules?
Use git clone --recurse-submodules <url> to clone and initialize submodules in one step. Alternatively, clone normally then run git submodule init and git submodule update.
- Why do submodules often end up in a detached HEAD state?
Because the parent repository points to a specific commit SHA, not a branch. When you update a submodule, Git checks out that exact commit, resulting in a detached HEAD.
- When would you use submodules vs a package manager?
Use submodules when you need to develop and modify the dependency alongside your project, or when it is not available through a package manager. Use package managers for stable, versioned libraries you consume but do not modify.
- How do you update a submodule to point to a newer commit?
Run git submodule update --remote to fetch the latest commit, then git add <submodule-path> and commit in the parent repo to record the new reference.
Exam Focus
Revise definitions, diagrams, examples, and short-answer points for Git Submodules - Manage External Dependencies as Git Repos.
Interview Use
Prepare one clear explanation, one practical example, and one common mistake for this Git & GitHub topic.
Search Terms
git-github, git & github, git, github, advanced, submodules, git submodules - manage external dependencies as git repos
Related Git & GitHub Topics
Continue learning this concept
Advanced GitGit Bisect - Find Bugs with Binary SearchLearn how to use git bisect to efficiently find the commit that introduced a bug using binary search. Master automated bisect with scripts and practical debugging workflows.Advanced GitGit Cherry-Pick - Apply Specific Commits to Any BranchLearn how to use git cherry-pick to apply individual commits from one branch to another. Master cherry-pick options, conflict resolution, and best practices.Advanced GitGit Hooks - Automate Workflows with Git EventsLearn to use Git hooks for automating code quality checks, commit message validation, pre-push testing, and deployment triggers. Covers client-side and server-side hooks.Advanced GitGit Internals - Understanding How Git Works Under the HoodDeep dive into Git internals including objects (blobs, trees, commits), the SHA-1 hash system, packfiles, refs, and how Git stores data as a content-addressable filesystem.Advanced GitGit Stash - Temporarily Save Uncommitted ChangesMaster git stash to save work-in-progress changes without committing. Learn stash operations, named stashes, partial stashing, and workflow patterns.Advanced GitGit Tag - Mark Important Points in HistoryLearn how to create, list, and manage Git tags for releases and milestones. Understand lightweight vs annotated tags, semantic versioning, and tag workflows.