Petit pense-bête pour mon moi future, qui aimera certainement se servir des sous-modules de Git (aka git submodule).
Il faut dans la mesure du possible, il faut utiliser des dépôts git en ligne pour héberger les sous-modules. L’intérêt étant de faciliter les échanges. Les sous-modules d’un projet seront accessibles par tous.
Ajouter un sous-module à un dépôt git :
- git submodule add URL_DEPOT
Rien de plus simple, le code est ajouté. On peut aussi passer un paramètre a après l’URL pour spécifier un répertoire d’installation.
C’était l’étape facile, et probablement la seule commande que l’on peut refaire sans avoir à chercher sur Stack Overflow.
On peu également demander le suivit d’une branche particulière :
- git submodule add -b master URL_DEPOT
Supprimer
Imaginons maintenant que l’ajout de ce module a été une erreur et qu’on en veille plus. On pourrait espérer n’avoir qu’à supprimer le code et faire un commit.
Trop simple ! D’abord il faut dé-initialiser le sous-module pour ensuite l’effacer :
- git submodule deinit PATH/SOUS_MODULE
- git rm --cached PATH/SOUS_MODULE
Alors qu’un :
- git submodule rm PATH/SOUS_MODULE
Serait plus logique.
Déplacer un sous-module
Cela demande git 1.9.3 au moins.
- git mv old/submod new/submod
Cela va déplacer un sous-module. A noté que l’on peu mv un répertoire complet qui contient des submodule, git s’y retrouve.
Un commande logique, cela fait plaisir !
Mettre à jour
Bon, imaginons maintenant qu’on est l’idée saugrenue de vouloir mettre à jour les sous-modules.
La commande logique serait :
- git submodule pull
Perdu ! Les sous-modules utilisent pour des raisons que j’ignore une commande update :
- git submodule update --remote
Si on ne met pas le remote, la commande ne fait rien. Et non dit pas qu’elle ne fait rien.
Cloner
Si un collègue veut récupérer le code avec des sous-modules, il va vouloir cloner le dépôt. Qui sera cloné SANS les sous-modules ! Il viendra vous voir, vert de rage, parce que ça ne marche pas cette merde !
Ou alors c’est un malin et il a fait :
- git clone --recursive URL
Ou alors il peut essayer d’activer les sous-modules :
- git submodule init
- git submodule update --remote
Je ne comprends pas pourquoi ces commandes manquent de logique ni pourquoi c’est si compliqué de gérer des sous-modules Git.
Une alternative serait d’utiliser Git subtree. Mais du coup on a d’autres problèmes.
Je pense que la bonne solution se situerait entre les deux : le code des sous-modules serait indexé dans le module parent, mais on conserverait la possibilité de modifier le code des enfants sans contrainte.