Opdatering og synkronisering af submodules

Når du arbejder med Git-submodules, peger hovedprojektet (superproject) normalt på en bestemt commit i submodulet, ikke nødvendigvis på den nyeste version.

I denne lektion lærer du, hvordan du opdaterer dine submodules til nyere versioner og sikrer, at deres konfigurationer er korrekte.

Den mest almindelige kommando til at opdatere submodules er git submodule update. Kommandoen gør to primære ting:

• Den checker den nøjagtige commit ud, som superprojectet forventer for hvert submodule.
• Den sikrer, at submodulets arbejdskatalog stemmer overens med den registrerede commit.

Den henter ikke nye commits fra submodulets fjernrepository.

Forestil dig, at dit hovedprojekts .gitmodules-fil angiver et submodule my-lib. Når en anden opdaterer my-lib i sit eget repository og derefter opdaterer superprojectets pegepind til my-lib, skal du opdatere.

Efter du har hentet ændringer i superprojectet, skal du køre dette for at få submodulets filer til at stemme overens med den nye registrerede commit:

Hvad nu, hvis du vil have dit submodule til at pege på den absolut nyeste commit på dets fjernbranches sporingsbranch og ikke kun den, som superprojectet har registreret?

Her er indstillingen --remote nyttig. Den henter fra submodulets fjernrepository og opdaterer dets HEAD til spidsen af den konfigurerede sporingsbranch (f.eks. main eller master).

Brug af --remote er en effektiv måde hurtigt at bringe submodules ajour med deres egne ændringer fra upstream. Det svarer til at køre git pull inde i hvert submodule.

Husk, at superprojectets submodule-pegepind efter dette er 'ude af synkronisering'. Du skal committe submodulets nye SHA-1-hash til superprojectet.

Nogle gange kan URL'en til et submodules fjernrepository ændre sig. Når det sker, skal URL'en, der er gemt i din lokale Git-konfiguration (.git/config) for det pågældende submodule, opdateres.

Kommandoen git submodule sync er udviklet til at synkronisere disse URL'er. Den læser URL'erne fra filen .gitmodules og opdaterer den lokale konfiguration for hvert submodule.

Du bruger typisk git submodule sync i disse situationer:

• Efter nogen ændrer et submodules URL i filen .gitmodules, og du henter disse ændringer.
• Når du kloner et repository med submodules for første gang, selvom git submodule update --init ofte håndterer dette implicit.
• Hvis du manuelt har ændret et submodules URL i .gitmodules og vil have din lokale konfiguration til at afspejle ændringen.

Lad os sige, at URL'en til dit my-lib-submodule blev ændret fra old-url.git til new-url.git i filen .gitmodules. Efter du har hentet denne ændring ind i dit superproject, peger din lokale konfiguration for my-lib stadig på den gamle URL.

Kør denne kommando for at rette det:

Hvis du vil have en robust arbejdsgang, der dækker de fleste situationer ved opdatering af submodules, kan du kombinere kommandoer:

• git pull origin main: Hent de nyeste ændringer i superprojectet.
• git submodule sync: Opdater submodule-URL'er, hvis de er blevet ændret.
• git submodule update --init --recursive --remote: Initialiser nye submodules, opdater alle eksisterende til deres nyeste version fra fjernrepositoryet, og håndter indlejrede submodules.

Det sikrer, at du er helt ajour.

Du har lært, hvordan du håndterer opdateringer af submoduler:

• git submodule update: Skifter til den commit, som hovedprojektet registrerer.
• git submodule update --remote: Henter de seneste ændringer fra submodulets fjernlager og opdaterer dets arbejdsmappe.
• git submodule sync: Synkroniserer submodulernes URL'er fra .gitmodules til din lokale Git-konfiguration.

Disse kommandoer er afgørende for at vedligeholde et velfungerende og opdateret projekt med submoduler!