5 filtyper, der skal inkluderes i din .gitignore

Versionskontrol er et vigtigt værktøj til at spore ændringer i din kodebase, men du ønsker ikke altid at spore hver fil.

For at undgå rod og mindske risikoen for at distribuere følsomme oplysninger kan du bruge en fil kaldet .gitignore. Denne fil specificerer hvilke filer og mapper Git ikke skal indeksere.

Det kan være en udfordring at bestemme, hvilke filer der skal inkluderes i .gitignore, især hvis du er ny inden for udvikling. Find ud af, hvilke filer du skal tilføje til din .gitignore for at få en mere jævn Git-arbejdsgang.

Oprettelse af en .gitignore-fil

For at din .gitignore-fil skal have nogen effekt, skal du have Git initialiseret i dit projekt.

Du kan initialisere Git ved at køre kommandoen nedenfor i din terminal:

git init

Denne kommando opretter et nyt Git-lager til dit projekt, i en skjult ".git"-undermappe, der indeholder alle de filer og mapper, den har brug for for at versionskontrollere dit projekt.

For at køre denne kommando skal du have Git installeret i dit system.

Opret derefter din .gitignore-fil ved at køre kommandoen nedenfor:

røre ved.gitignore

Ved at køre kommandoen ovenfor oprettes en ny fil, ".gitignore" i din nuværende mappe. Du kan ekskludere en fil fra Git ved at tilføje filnavnet eller filstien (hvis filen er i en anden mappe end .gitignore fil).

Git behøver ikke at spore alle filer i dit projekt, og sporing af nogle filer kan føre til uforudsete problemer. Dette er nogle af de filer, du bør tilføje til din .gitignore.

1. Konfigurationsfiler

Konfigurationsfiler gemmer indstillinger og andre parametre, som dine applikationer bruger til at definere og tilpasse deres adfærd. Disse filer gemmer ofte databaseforbindelsesstrenge, API-nøgler og andre følsomme oplysninger, som du ikke bør afsløre i dit Git-lager.

Hvis du inkluderer konfigurationsfiler i dit lager, kan alle, der har adgang til det, se deres indhold. Det kan omfatte følsomme oplysninger, som kan føre til sikkerhedsbrud og andre problemer.

For at udelukke konfigurationsfiler fra dit Git-lager skal du tilføje specifikke filnavne eller mappenavne til din .gitignore fil.

Du kan f.eks. tilføje linjen nedenfor til din .gitignore fil for at ignorere en .env fil.

.env

2. Byg artefakter

Byg artefakter er de kompilerede eller genererede filer, der produceres, når du bygger dit projekt. Disse filer lever typisk i en "mål" eller "bygge" vejviser.

Byg-artefakter kan omfatte kompilerede Java-klasser, JAR-filer, WAR-filer, binære filer, distributionspakker, rapporter, logfiler og andre genereret under byggeprocessen.

Det er generelt en god praksis at udelukke byggeartefakter fra dit Git-lager, fordi de kan være meget store. De kan også være mindre bærbare end dine kildefiler, kun relevante for et specifikt miljø. At inkludere dem i dit depot kan svulme op på størrelsen af ​​dit depot og gøre det langsommere at klone og arbejde med.

For at udelukke byggeartefakter fra dit Git-lager skal du tilføje "mål/" eller "bygge/" mappe til din .gitignore fil.

For eksempel:

# .gitignore
mål/
bygge/

3. Integrerede udviklingsmiljøfiler

Integrated Development Environment-filer (IDE) er konfigurationsfiler, projektmetadata og andre filer, der genereres af din IDE, når du opretter eller åbner et projekt. Disse filer er specifikke for hver IDE. Din IDE bruger disse filer til at konfigurere projektindstillingerne.

Disse filer er unødvendige for at bygge eller køre din applikation og kan ofte forårsage problemer, hvis de er forpligtet til et delt Git-lager. For eksempel kan forskellige personer på dit team bruge forskellige IDE'er eller versioner, og committing af IDE-specifikke filer kan forårsage flettekonflikter og gøre det vanskeligt at samarbejde om projektet.

Da disse filer er IDE-specifikke, skal filerne inkludere i din .gitignore fil vil afhænge af din IDE. Her er GitHubs .gitignore anbefalinger for nogle populære IDE'er. Du kan søge efter din valgte IDE og tilføje de skitserede filer til din .gitignore fil.

4. Afhængigheds- og pakkefiler

Afhængigheds- og pakkefiler er filer, der indeholder oplysninger om de afhængigheder og pakker, der bruges af dit program. Forskellige byggeværktøjer, som f.eks Node Package Manager (npm), generere disse filer.

For eksempel, hvis du bruger npm til at administrere afhængigheder for et JavaScript-projekt, vil det skabe en "node_modules" mappe i dit projekts rodmappe. Biblioteket indeholder alle de installerede afhængigheder for dit projekt.

Denne mappe kan blive meget stor, især hvis dit projekt har mange afhængigheder eller nogle afhængigheder har store filstørrelser. Ved at udelukke "node_modules"-mappen fra dit Git-lager, kan du holde den ren og reducere dens størrelse.

For at undgå at tilføje "node_modules"-mappen til dit Git-lager, tilføj dens navn til din .gitignore-fil:

#.gitignore
node_modules/

5. Operativsystemfiler

Dit operativsystem og andre systemværktøjer kan generere filer ved normal brug. Disse kan omfatte logfiler, midlertidige filer og systemkonfigurationsfiler. Et eksempel er Thumbs.db fil på Windows og dens macOS-ækvivalent, den .DS_Store fil.

Det er generelt en god praksis at udelukke operativsystemfiler fra dit Git-lager, da de er specifikke for dit lokale miljø og kan variere mellem forskellige computere og drift systemer.

GitHub har anbefalet .gitignore retningslinjer for Windows, macOS, og Linux.

Vigtigheden af ​​versionskontrol

Brug af versionskontrol kan forbedre dit arbejdsflow markant og reducere fejl og konflikter, der kan opstå, når du arbejder på en kodebase. Med versionskontrol kan du nemt spore kodeændringer, gennemgå dem og samarbejde problemfrit med teammedlemmer.

Du bør dog altid udelukke visse filer, såsom konfigurationsfiler, IDE-filer og OS-filer. Dette vil holde størrelsen af ​​dit lager nede og sikre, at du ikke lækker følsom information.