Submodules toevoegen en klonen

Met Git-submodules kunt u één Git-repository in een andere insluiten. Dit is nuttig voor het beheren van externe afhankelijkheden, zoals bibliotheken of gedeelde componenten.

In deze les leert u hoe u een nieuwe submodule aan uw project toevoegt en hoe u een repository met submodules correct kloont.

Om een submodule toe te voegen gebruikt u de opdracht git submodule add. Deze opdracht gebruikt de URL van de externe repository en optioneel een lokaal pad waar u de submodule wilt plaatsen.

• Repository-URL: De URL (HTTPS of SSH) van de Git-repository van de submodule.
• Pad: De map binnen uw hoofdproject waarin de submodule komt te staan. Als u dit weglaat, gebruikt Git de naam van de repository.

Stel dat u een repository my-project hebt en een gedeelde bibliotheek uit https://github.com/example/shared-lib.git wilt opnemen.

Ga eerst naar de map van uw hoofdproject.

Na het uitvoeren van git submodule add doet Git enkele dingen:

• Git kloont de repository van de submodule naar het opgegeven pad (bijvoorbeeld lib/shared-lib).
• Git voegt een vermelding toe aan een speciaal bestand met de naam .gitmodules in de hoofdmap van uw hoofdrepository.
• Git zet de nieuwe submodulemap en het bestand .gitmodules klaar voor een commit.

Het bestand .gitmodules is een configuratiebestand met de koppeling tussen het lokale pad van de submodule en de externe URL. Het is essentieel om anderen uw project correct te laten klonen.

Zo kan het er voor ons voorbeeld uitzien:

Een submodule toevoegen is een wijziging aan uw hoofdrepository, dus u moet deze committen. De commit registreert de specifieke commit-hash van de repository van de submodule die uw hoofdproject momenteel gebruikt.

Wanneer u een repository met submodules kloont, kloont Git de bovenliggende repository, maar wordt de inhoud van de submodules niet automatisch gedownload.

De submodulemappen verschijnen leeg of bevatten alleen een bestand .git dat naar de repository van de submodule verwijst.

De eenvoudigste manier om een repository en al zijn submodules te klonen is de vlag --recurse-submodules te gebruiken met git clone.

Met deze opdracht wordt de hoofdrepository gekloond en worden vervolgens alle submodules automatisch geïnitialiseerd en bijgewerkt naar hun juiste versies.

Als u tijdens het klonen --recurse-submodules bent vergeten, hoeft u zich geen zorgen te maken! U kunt de submodules na het klonen van de bovenliggende repository handmatig initialiseren en bijwerken.

Ga eerst naar de gekloonde bovenliggende repository.

Na het initialiseren moet u Git opdracht geven de daadwerkelijke inhoud van elke submodule op te halen. Dit doet u met de opdracht git submodule update.

Deze haalt de gegevens op uit de externe repository van de submodule en checkt de specifieke commit uit die door de bovenliggende repository is geregistreerd.

In deze les hebt u geleerd hoe u:

• Een submodule toevoegt met git submodule add <url> <path>, waarmee een bestand .gitmodules wordt gemaakt en de submodule wordt klaargezet.
• Wijzigingen aan submodules commit om de specifieke versie van de submodule in de bovenliggende repository vast te leggen.
• Een repository met submodules kloont met git clone --recurse-submodules voor een alles-in-één-bewerking.
• Submodules handmatig initialiseert en bijwerkt met git submodule init en git submodule update als u zonder de vlag voor recursie hebt gekloond.

Vervolgens bekijken we hoe u submodules beheert en bijwerkt nadat ze zijn toegevoegd en gekloond.