Tilføjelse og kloning af submodules

Git-submodules giver dig mulighed for at indlejre ét Git-repository i et andet. Det er nyttigt til administration af eksterne afhængigheder som biblioteker eller delte komponenter.

I denne lektion lærer du, hvordan du tilføjer et nyt submodule til dit projekt, og hvordan du kloner et repository, der indeholder submodules, korrekt.

Hvis du vil tilføje et submodule, bruger du kommandoen git submodule add. Kommandoen tager URL'en til det eksterne repository og eventuelt en lokal sti, hvor du vil placere det.

• Repository-URL: URL'en (HTTPS eller SSH) til submodulets Git-repository.
• Sti: Mappen i dit hovedprojekt, hvor submodulet skal ligge. Hvis den udelades, bruger Git repositoryets navn.

Lad os sige, at du har et my-project-repository og vil inkludere et delt bibliotek fra https://github.com/example/shared-lib.git.

Gå først til mappen for dit hovedprojekt.

Efter du har kørt git submodule add, gør Git nogle få ting:

• Det kloner submodulets repository til den angivne sti (f.eks. lib/shared-lib).
• Det tilføjer en post til en særlig fil med navnet .gitmodules i roden af dit hovedrepository.
• Det stage'r den nye submodule-mappe og filen .gitmodules til commit.

Filen .gitmodules er en konfigurationsfil, der gemmer sammenhængen mellem submodulets lokale sti og dets fjern-URL. Den er afgørende for, at andre kan klone dit projekt korrekt.

Sådan kan den se ud i vores eksempel:

Tilføjelse af et submodule er en ændring i dit hovedrepository, så du skal committe den. Committen registrerer den specifikke commit-hash i submodulets repository, som dit hovedprojekt bruger i øjeblikket.

Når du kloner et repository, der indeholder submodules, kloner Git det overordnede repository, men downloader ikke automatisk submodulets indhold.

Submodule-mapperne vises som tomme eller indeholder kun en .git-fil, der peger på submodulets repository.

Den mest enkle måde at klone et repository og alle dets submodules på er at bruge flaget --recurse-submodules sammen med git clone.

Denne kommando kloner hovedrepositoryet og initialiserer og opdaterer derefter automatisk alle submodules til deres korrekte versioner.

Hvis du glemmer --recurse-submodules under kloningen, skal du ikke bekymre dig! Du kan initialisere og opdatere dem manuelt efter kloningen af det overordnede repository.

Gå først ind i det klonede overordnede repository.

Efter initialiseringen skal du fortælle Git, at det skal hente det faktiske indhold for hvert submodule. Det gør du med kommandoen git submodule update.

Den henter data fra submodulets fjernrepository og checker den specifikke commit ud, som det overordnede repository har registreret.

I denne lektion lærte du, hvordan du:

• Tilføjer et submodule med git submodule add <url> <path>, hvilket opretter en .gitmodules-fil og stager submodulet.
• Committer ændringer af submodules for at registrere submodulets specifikke version i det overordnede repository.
• Kloner et repository med submodules med git clone --recurse-submodules som en samlet handling.
• Initialiserer og opdaterer submodules manuelt med git submodule init og git submodule update, hvis du klonede uden recurse-flaget.

Dernæst undersøger du, hvordan du administrerer og opdaterer submodules, efter at de er blevet tilføjet og klonet.