Synopsis
git subtree add --prefix=<path> <repo> <ref> [--squash]
git subtree pull --prefix=<path> <repo> <ref>
git subtree push --prefix=<path> <repo> <ref>
git subtree split --prefix=<path> -b <new-branch>
Description
The git subtree command is an alternative to submodules that merges another project's content directly into a subdirectory of your repo. Unlike submodules, subtree consumers don't need any special steps — the files are simply there. The cost is that the foreign history is incorporated into your own.
The two main operations are add (initial import, often with --squash to flatten history) and pull (bring in upstream changes). To send back changes, git subtree push filters out commits that touch the prefix and pushes them to the upstream repo.
Dans l'usage quotidien, git subtree 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 subtree --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 subtree 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 subtree aide à éviter les trois.
Options courantes
| Sous-commande | Description |
|---|---|
add | Import an external repo into a subdirectory. |
pull | Merge upstream changes for that prefix. |
push | Push prefix-only history back upstream. |
merge | Merge an arbitrary tree into the prefix. |
split | Extract a subdirectory's history as a standalone branch. |
--squash | Flatten foreign history into a single commit. |
--prefix=<path> | Subdirectory under which to place the subtree. |
Exemples
git subtree add --prefix=vendor/foo https://github.com/lib/foo.git main --squash
# Import foo into vendor/foo, squashing history
git subtree pull --prefix=vendor/foo https://github.com/lib/foo.git main --squash
# Pull updates
git subtree split --prefix=lib -b lib-only
# Extract lib/ as its own branch for sharing
git subtree push --prefix=vendor/foo upstream main
# Send prefix-scoped commits back to upstream
Erreurs fréquentes
Mixing --squash on some operations and not others creates messy history. Pick one mode and stick with it. Subtree merges produce nontrivial commit graphs that confuse some tooling. git subtree split can be slow on large histories.
Commandes liées
git submodule, git merge, git filter-repo