Ignorerer filer og mapper i git (.gitignore)

Når du arbejder på et projekt, der bruger Git, vil du ofte udelukke, at bestemte filer eller mapper bliver skubbet til fjernlageret.

.gitignore filen specificerer, hvilke ikke-sporede filer Git skal ignorere.

Hvilke filer skal ignoreres?

Ignorerede filer er normalt platformspecifikke filer eller automatisk oprettede filer fra build-systemerne. Nogle almindelige eksempler inkluderer:

• Kørselsfiler såsom log, lås, cache eller midlertidige filer. Filer med følsom information, såsom adgangskoder eller API-nøgler. Kompileret kode, f.eks. .class eller.o-afhængighedsmapper, såsom /vendor eller /node_modules Byg kataloger., såsom /public , /out eller /dist Systemfiler som .DS_Store eller Thumbs.db IDE eller teksteditor-konfigurationsfiler.

Gitignore

En lokal .gitignore fil placeres normalt i .gitignore rodmappe. Du kan dog oprette flere .gitignore filer i forskellige undermapper i dit depot. Mønstrene i .gitignore filer matches i forhold til det bibliotek, hvor filen findes.

Mønstre, der er defineret i filerne, der er placeret i kataloger på lavere niveau (underkataloger) har forrang end mønstre i kataloger på højere niveau.

Lokale .gitignore filer deles med andre udviklere og skal indeholde mønstre, der er nyttige for alle andre brugere af depotet.

Regler for personlig ignorering

Mønstre, der er specifikke for dit lokale arkiv og ikke bør distribueres til andre depoter, skal indstilles i .git/info/exclude .

For eksempel kan du bruge denne fil til at ignorere genererede filer fra dine personlige projektværktøjer.

Global .gitignore

Med Git kan du også oprette en global .gitignore fil, hvor du kan definere ignoreringsregler for hvert Git-lager på dit lokale system.

Filen kan navngives alt, hvad du kan lide og gemmes på ethvert sted. Det mest almindelige sted at opbevare denne fil er hjemmekatalogen. Du skal manuelt oprette filen og konfigurere Git til at bruge den.

For at indstille ~/.gitignore_global som den globale Git ignoreringsfil, gør du for eksempel følgende:

1. Opret filen:

   touch ~/.gitignore_global

   Føj filen til Git-konfigurationen:

   git config --global core.excludesfile ~/.gitignore_global

   Åbn filen med din teksteditor, og tilføj dine regler til den.

Globale regler er især nyttige til at ignorere bestemte filer, som du aldrig ønsker at udføre, f.eks. Filer med følsom information eller kompilerede eksekverbare filer.

Ignorering af tidligere foretagne filer

Filerne i din arbejdskopi kan enten spores eller ikke spores.

For at ignorere en fil, der tidligere er blevet begået, skal du fjerne scenen og fjerne filen fra indekset og derefter tilføje en regel for filen i .gitignore :

git rm --cached filename

--cached fortæller git om ikke at slette filen fra arbejdstræet, men kun at fjerne den fra indekset.

Hvis du vil fjerne et bibliotek rekursivt, skal du bruge indstillingen -r :

git rm --cached filename

Når du rekursivt sletter filer, skal du bruge indstillingen -n , der udfører et "tørt løb" og vise dig, hvilke filer der vil blive slettet:

git rm -r -n directory

Fejlsøgning .gitignore fil

Nogle gange kan det være udfordrende at bestemme, hvorfor en bestemt fil ignoreres, især når du bruger flere .gitignore filer eller komplekse mønstre. Det er her, git check-ignore kommandoen med -v indstillingen, der fortæller git at vise detaljer om det matchende mønster, er praktisk.

For at kontrollere, hvorfor filen www/yarn.lock ignoreres, ville du f.eks. Køre:

git check-ignore -v www/yarn.lock

gitignore viser stien til gitignore filen, nummeret på den matchende linje og det faktiske mønster.

www/.gitignore:31:/yarn.lock www/yarn.lock

Kommandoen accepterer også mere end et filnavn som argumenter, og filen behøver ikke at eksistere i dit arbejdstræ.

Viser alle ignorerede filer

--ignored git status med indstillingen --ignored viser en liste over alle ignorerede filer:

git status --ignored

Konklusion

.gitignore filen giver dig mulighed for at ekskludere filer fra at blive kontrolleret i depotet. Filen indeholder globende mønstre, der beskriver hvilke filer og mapper, der skal ignoreres.

gitignore.io er en online tjeneste, der giver dig mulighed for at generere .gitignore filer til dit operativsystem, dit programmeringssprog eller IDE.