Vergelijking van Subtree en submodule

Welkom bij de laatste les van onze minicursus over Git Subtree! We hebben onderzocht wat Git Subtree is en hoe je het gebruikt. Nu is het tijd om het te vergelijken met Git Submodules.

Beide hulpmiddelen helpen externe afhankelijkheden binnen een hoofdrepository te beheren, maar ze doen dit op fundamenteel verschillende manieren. Inzicht in deze verschillen is essentieel om de juiste strategie voor je project te kiezen.

Je weet nog dat Git Submodules je toestaan om één Git-repository als submap in een andere op te nemen. De hoofdrepository slaat een verwijzing op naar een specifieke commit in de repository van de submodule.

• Afzonderlijke geschiedenissen: Elke submodule heeft zijn eigen onafhankelijke Git-geschiedenis.
• Aanwijzers, geen kopieën: De bovenliggende repository slaat alleen een aanwijzer naar de commit van de submodule op, niet de daadwerkelijke inhoud.
• Gedecentraliseerde ontwikkeling: Ideaal wanneer je rechtstreeks wilt bijdragen aan de upstream-afhankelijkheid.

Submodules bieden duidelijke voordelen, vooral in specifieke situaties:

• Duidelijke scheiding: De geschiedenis van de afhankelijkheid is volledig geïsoleerd van de geschiedenis van het hoofdproject.
• Bijdragen aan upstream: Je kunt eenvoudig wijzigingen in de submodule aanbrengen en deze rechtstreeks naar de oorspronkelijke upstream-repository pushen.
• Versies vastzetten: Je kunt een submodule aan een exacte commit koppelen, zodat stabiliteit wordt gegarandeerd.
• Verdeeld eigenaarschap: Handig wanneer verschillende teams verschillende onderdelen van een groter systeem beheren.

Ondanks hun voordelen brengen submodules een aantal complexiteiten met zich mee die vooral voor beginners lastig kunnen zijn:

• Complexiteit bij het klonen: Na het klonen zijn extra stappen nodig (git submodule init, git submodule update).
• Losgekoppelde HEAD: Je komt bij het werken in een submodule vaak in een toestand met een 'losgekoppelde HEAD' terecht, wat verwarrend kan zijn.
• Geschiedenisbeheer: Bij het bijwerken van submodules moet je een nieuwe aanwijzer in het bovenliggende project vastleggen, wat tot frequente updates kan leiden.
• Problemen met branches: Bij het wisselen van branches in de bovenliggende repository moet je submodules mogelijk handmatig bijwerken.

Git Subtree werkt daarentegen anders. In wezen kopieert het de inhoud van de externe repository naar een submap van je hoofdproject.

• Geïntegreerde geschiedenis: De geschiedenis van de afhankelijkheid wordt rechtstreeks samengevoegd met de geschiedenis van je hoofdrepository.
• Geen afzonderlijke repositories: Het is gewoon een submap, geen afzonderlijke Git-repository binnen die van jou.
• Vereenvoudigde werkwijze: De afhankelijkheid verschijnt als een normaal onderdeel van je project, waardoor het voor nieuwe bijdragers eenvoudiger wordt.

Subtree komt goed tot zijn recht wanneer eenvoud en werken met één repository prioriteit hebben:

• Eenvoudiger klonen: Er zijn geen speciale opdrachten nodig; met een eenvoudige git clone haal je alles op.
• Eén repository: Alle code staat in één repository, waardoor CI/CD en machtigingen eenvoudiger worden.
• Geen detached HEAD: Je bevindt je altijd op een branch binnen de hoofdrepository.
• Eenvoudiger voor gebruikers: Ontwikkelaars hoeven geen opdrach­ten te leren die specifiek zijn voor submodules.
• Eenvoudiger herstructureren: Bestanden binnen de subtree verplaatsen werkt net als het verplaatsen van elk ander bestand in je repository.

Hoewel Git Subtree in sommige opzichten eenvoudiger is, heeft het ook zijn eigen nadelen:

• Onoverzichtelijke geschiedenis: De geschiedenis van de afhankelijkheid wordt samengevoegd met die van je hoofdproject, waardoor je git log mogelijk langer en moeilijker leesbaar wordt.
• Complexe updates: Voor het ophalen van updates uit de upstream-subtree zijn specifieke git subtree pull-opdrachten nodig. Die zijn mogelijk minder intuïtief dan een eenvoudige git pull.
• Wijzigingen naar upstream terugsturen: Om wijzigingen binnen de subtree terug naar de oorspronkelijke repository te sturen, heb je ook een specifieke git subtree push-opdracht nodig. Dat kan omslachtiger zijn.
• Duplicatie: De code van de afhankelijkheid wordt fysiek naar je repository gekopieerd, waardoor deze groter wordt.

Het belangrijkste verschil zit in de manier waarop ze de geschiedenis beheren:

• Submodules: Behouden een duidelijke scheiding. Je hoofdrepository registreert alleen een verwijzing naar een specifieke commit in de onafhankelijke geschiedenis van de submodule.
• Subtree: Integreert de geschiedenis van de afhankelijkheid rechtstreeks in de geschiedenis van je hoofdproject. Het is alsof je al die wijzigingen zelf hebt gekopieerd en gecommit.

Dit verschil heeft invloed op alles: van klonen en bijwerken tot samenwerken aan de afhankelijkheid.

Denk na over de dagelijkse werkwijze van ontwikkelaars:

• Submodules: Explicieter. Ontwikkelaars moeten weten dat ze met een afzonderlijke Git-repository werken. Opdrachten zoals git submodule update zijn essentieel.
• Subtree: Naadlozer. Zodra de subtree is toegevoegd, gedraagt deze zich als elke andere map in de hoofdrepository. Basisopdrachten van Git (add, commit, pull, push) werken doorgaans zonder speciale aandacht voor de subtree zelf.

Subtree verlaagt over het algemeen de instapdrempel voor teamleden die de afhankelijkheid alleen hoeven te gebruiken.

Welke moet je kiezen?

• Gebruik Submodules wanneer:
  - Je regelmatig wilt bijdragen aan de upstream van de afhankelijkheid.
  - De afhankelijkheid een afzonderlijk, actief ontwikkeld project is.
  - Je de voorkeur geeft aan strikt vastgezette versies en geïsoleerde geschiedenissen.
  - Je team vertrouwd is met werkwijzen voor Git-submodules.
• Gebruik Subtree wanneer:
  - Je een eenvoudigere werkwijze wilt voor gebruikers van de afhankelijkheid.
  - Je zelden wijzigingen terug hoeft te sturen naar de upstream-afhankelijkheid.
  - De afhankelijkheid intern is of je gewoon code wilt meeleveren.
  - Je vanwege de eenvoud de voorkeur geeft aan één uniforme repositorygeschiedenis.

In deze les hebben we de belangrijkste verschillen tussen Git Submodules en Git Subtree ontleed.

• Submodules behouden afzonderlijke geschiedenissen en vereisen expliciete opdrachten. Ze bieden sterke isolatie en maken bijdragen aan upstream eenvoudig.
• Subtree integreert de geschiedenis, vereenvoudigt het klonen en biedt een uniforme repository-ervaring, maar kan updates en het terugsturen van wijzigingen naar upstream complexer maken.

Je keuze hangt af van de behoeften van je project, de mate waarin je team met de werkwijze vertrouwd is en de aard van je afhankelijkheden. Beide zijn krachtige tools wanneer je ze in de juiste context gebruikt!