Subtree toevoegen en samenvoegen

Welkom! In deze les gaan we dieper in op Git Subtree, een krachtige manier om een andere Git-repository rechtstreeks in je project te integreren.

In tegenstelling tot submodules voegt subtree de geschiedenis van de externe repository samen met die van jou, waardoor deze aanvoelt als een native onderdeel van je project.

Subtree biedt in veel gevallen een eenvoudigere werkwijze dan submodules. Dit zijn enkele voordelen:

• Geen speciale opdrachten: Nadat de subtree is toegevoegd, werk je met de inhoud ervan zoals met gewone bestanden.
• Eén repository: Geen afzonderlijke .git-mappen of ingewikkelde initialisatie van submodules.
• Eenvoudiger voor gebruikers: Anderen die je project klonen, hoeven geen speciale submodule-opdrachten te leren.

Controleer voordat je een subtree toevoegt of je hoofdrepository schoon is (geen niet-vastgelegde wijzigingen). Je hebt het volgende nodig:

• De URL van de externe repository.
• De branch of commit die je wilt integreren (bijvoorbeeld main of master).
• Een gekozen pad binnen je hoofdrepository voor de subtree.

Om een externe repository als subtree toe te voegen, gebruik je de opdracht git subtree add. Deze ziet er als volgt uit:

git subtree add --prefix=<path> <repository> <ref>

• --prefix=<path>: De map in je project waarin de subtree komt te staan.
• <repository>: De URL van de externe Git-repository.
• <ref>: De branch (bijvoorbeeld main) of commit-hash uit de externe repository.

Stel dat je een gedeelde utility-library uit een afzonderlijke Git-repository wilt toevoegen aan een map src/shared in je huidige project. Je gebruikt dan:

git subtree add --prefix=src/shared/utility-library https://github.com/myorg/utility-library.git main

Deze opdracht haalt de main-branch van utility-library op en integreert de geschiedenis ervan in je map src/shared/utility-library.

Wanneer je een subtree toevoegt, zie je vaak de optie --squash:

git subtree add --prefix=path repo_url main --squash

De optie --squash combineert alle commits uit de geschiedenis van de externe repository tot één enkele commit in je hoofdproject. Zo blijft de geschiedenis van je hoofdproject overzichtelijker, maar verlies je de details van de afzonderlijke commits uit de oorspronkelijke geschiedenis van de subtree.

Nadat je een subtree hebt toegevoegd, kan de oorspronkelijke externe repository nieuwe updates ontvangen. Om je geïntegreerde code actueel te houden met de upstream-bron, moet je die wijzigingen ophalen.

Zo beschikt je project altijd over de nieuwste versies van de gedeelde componenten of bibliotheken die je als subtree hebt opgenomen.

Om updates uit een upstream-subtree op te halen, gebruik je een vergelijkbare opdrachtstructuur:

git subtree pull --prefix=<path> <repository> <ref>

Je ziet dat dezelfde --prefix, <repository> en <ref> worden gebruikt als bij het toevoegen. Git gebruikt deze om de juiste upstream-bron voor je subtree te identificeren.

Laten we doorgaan met ons voorbeeld van utility-library. Om de nieuwste wijzigingen uit de main-branch ervan naar je project op te halen, voer je het volgende uit:

git subtree pull --prefix=src/shared/utility-library https://github.com/myorg/utility-library.git main

Deze opdracht haalt nieuwe commits uit de main-branch van utility-library op en voegt ze samen met je lokale map src/shared/utility-library.

Je hebt geleerd hoe je externe repositories met Git Subtree kunt integreren!

• Gebruik git subtree add met --prefix, de URL van de repository en een branch om externe code in je project op te nemen.
• De optie --squash helpt om de geschiedenis van je hoofdproject overzichtelijk te houden.
• Gebruik git subtree pull met dezelfde parameters om upstream-updates op te halen en met je subtree samen te voegen.

Subtree biedt een krachtig, geïntegreerd alternatief voor submodules voor het beheren van gedeelde code!