Synopsis

git submodule add <url> <path>
git submodule update --init --recursive
git submodule foreach <cmd>

Description

The git submodule command embeds an external Git repository inside another at a fixed commit. The parent repo records the submodule URL and the exact SHA to check out, decoupling parent and child histories. This is useful for vendoring shared libraries or composing multi-repo systems.

Submodules are powerful but have a reputation for confusion. After cloning a project with submodules, you must run git submodule update --init --recursive to populate them. Updating to a newer submodule commit is a two-step dance: pull inside the submodule, then commit the new SHA in the parent.

Dans l'usage quotidien, git submodule s'intègre étroitement avec les alias de shell, les plugins d'éditeur et l'intégration continue. Les utilisateurs avancés ajoutent souvent des alias combinant les flags qu'ils passent toujours, ou enveloppent la commande dans des scripts qui appliquent les conventions d'équipe. Le formatage de la sortie peut être personnalisé via la configuration Git — pretty formats, schémas de couleurs et comportement du pager sont tous ajustables. Quand quelque chose tourne mal, la première étape de diagnostic est généralement de relancer la commande avec GIT_TRACE=1 dans l'environnement, ce qui révèle les appels de plomberie sous-jacents. Pour les situations inhabituelles, la sortie --help (git submodule --help) ouvre la page de manuel complète avec les détails de chaque option, y compris celles rarement utilisées dans les workflows ordinaires mais essentielles pour le débogage ou le scripting à grande échelle.

Comprendre comment git submodule interagit avec le reste du modèle de données de Git — la base d'objets, l'index, les refs et l'arborescence de travail — est rentable. Chaque commande opère sur un sous-ensemble de ces pièces, et savoir laquelle elle touche aide à prédire les résultats et récupérer après les erreurs. Lire la documentation officielle de Git en parallèle de la pratique sur un dépôt jetable est la façon la plus rapide d'intérioriser les subtilités. La plupart des problèmes de production avec Git proviennent de l'une de trois causes : comportement par défaut surprenant, opérations réseau partielles, ou réécriture d'historique déjà partagé. Un modèle mental fonctionnel des effets de bord de git submodule aide à éviter les trois.

Options courantes

Exemples

git submodule add https://github.com/lib/foo.git vendor/foo
# Add a new submodule at vendor/foo

git clone --recurse-submodules https://github.com/me/parent.git
# Clone with submodules in one step

git submodule update --init --recursive
# Initialize and populate all submodules

git submodule foreach 'git pull origin main'
# Update each submodule to its main branch tip

Erreurs fréquentes

Forgetting --recurse-submodules on clone leaves empty submodule directories. Pushing the parent repo without first pushing submodule changes leaves a dangling reference for collaborators. Many teams move to git subtree or monorepos to escape submodule complexity.

Commandes liées

git subtree, git clone --recurse-submodules, git config submodule