5 typov súborov, ktoré treba zahrnúť do vášho .gitignore

Kontrola verzií je dôležitým nástrojom na sledovanie zmien vo vašej kódovej základni, no nie vždy chcete sledovať každý súbor.

Ak sa chcete vyhnúť neporiadku a znížiť riziko distribúcie citlivých informácií, môžete použiť súbor s názvom .gitignore. Tento súbor určuje, ktoré súbory a adresáre by Git nemal indexovať.

Určenie, ktoré súbory zahrnúť do .gitignore, môže byť problém, najmä ak ste vo vývoji nováčikom. Zistite, ktoré súbory by ste mali pridať do svojho .gitignore, aby ste dosiahli plynulejší pracovný postup Git.

Vytvorenie súboru .gitignore

Aby mal váš súbor .gitignore nejaký účinok, musíte mať vo svojom projekte inicializovaný Git.

Git môžete inicializovať spustením nižšie uvedeného príkazu vo svojom termináli:

git init

Tento príkaz vytvorí nové úložisko Git pre váš projekt v skrytom podadresári „.git“, ktorý obsahuje všetky súbory a adresáre potrebné na riadenie verzií vášho projektu.

Ak chcete spustiť tento príkaz, musíte mať Git nainštalovaný vo vašom systéme.

Potom vytvorte súbor .gitignore spustením príkazu nižšie:

dotyk.gitignore

Spustením vyššie uvedeného príkazu sa vo vašom aktuálnom adresári vytvorí nový súbor „.gitignore“. Súbor môžete z Gitu vylúčiť pridaním názvu súboru alebo cesty k súboru (ak je súbor v inom adresári ako .gitignore súbor).

Git nemusí sledovať každý súbor vo vašom projekte a sledovanie niektorých súborov môže viesť k nepredvídaným problémom. Toto sú niektoré zo súborov, ktoré by ste mali pridať do svojho .gitignore.

1. Konfiguračné súbory

Konfiguračné súbory ukladajú nastavenia a ďalšie parametre, ktoré vaše aplikácie používajú na definovanie a prispôsobenie svojho správania. Tieto súbory často ukladajú reťazce pripojenia k databáze, kľúče API a ďalšie citlivé informácie, ktoré by ste nemali zverejňovať vo svojom úložisku Git.

Ak do svojho archívu zahrniete konfiguračné súbory, každý, kto má k nemu prístup, môže zobraziť ich obsah. To môže zahŕňať citlivé informácie, ktoré môžu viesť k narušeniu bezpečnosti a iným problémom.

Ak chcete vylúčiť konfiguračné súbory z vášho úložiska Git, pridajte doň konkrétne názvy súborov alebo priečinkov .gitignore súbor.

Môžete napríklad pridať riadok nižšie do svojho .gitignore ignorovať súbor a .env súbor.

.env

2. Budujte artefakty

Artefakty zostavy sú skompilované alebo vygenerované súbory vytvorené pri zostavovaní projektu. Tieto súbory zvyčajne žijú v a "cieľ" alebo "stavať" adresár.

Artefakty zostavy môžu zahŕňať kompilované triedy Java, súbory JAR, súbory WAR, binárne súbory, distribučné balíky, zostavy, protokolové súbory a iné generované počas procesu zostavovania.

Vo všeobecnosti je dobrým zvykom vylúčiť artefakty zostavy z vášho úložiska Git, pretože môžu byť veľmi veľké. Môžu byť tiež menej prenosné ako vaše zdrojové súbory, relevantné len pre konkrétne prostredie. Ich zahrnutie do vášho úložiska môže nafúknuť veľkosť vášho úložiska a spomaliť jeho klonovanie a prácu s ním.

Ak chcete vylúčiť artefakty zostavy z vášho úložiska Git, pridajte "cieľ/" alebo "stavať/" adresár do vášho .gitignore súbor.

Napríklad:

# .gitignore
cieľ/
stavať/

3. Súbory integrovaného vývojového prostredia

Súbory integrovaného vývojového prostredia (IDE) sú konfiguračné súbory, metaúdaje projektu a ďalšie súbory generované vaším IDE pri vytváraní alebo otváraní projektu. Tieto súbory sú špecifické pre každé IDE. Vaše IDE používa tieto súbory na konfiguráciu nastavení projektu.

Tieto súbory nie sú potrebné na zostavenie alebo spustenie vašej aplikácie a často môžu spôsobiť problémy, ak sú uložené v zdieľanom úložisku Git. Rôzni ľudia vo vašom tíme môžu napríklad používať rôzne IDE alebo verzie a odovzdanie súborov špecifických pre IDE môže spôsobiť konflikty pri zlučovaní a sťažiť spoluprácu na projekte.

Keďže tieto súbory sú špecifické pre IDE, súbory, ktoré chcete zahrnúť do svojho .gitignore súbor bude závisieť od vášho IDE. Tu sú Odporúčania GitHubu .gitignore pre niektoré populárne IDE. Môžete vyhľadať IDE podľa vlastného výberu a pridať načrtnuté súbory do svojho .gitignore súbor.

4. Závislosť a súbory balíkov

Súbory závislostí a balíkov sú súbory, ktoré obsahujú informácie o závislostiach a balíkoch používaných vašou aplikáciou. Rôzne stavebné nástroje, ako napr správca balíkov uzlov (npm), vygenerujte tieto súbory.

Ak napríklad použijete npm na správu závislostí pre projekt JavaScript, vytvorí sa „node_modules“ v koreňovom adresári vášho projektu. Adresár obsahuje všetky nainštalované závislosti pre váš projekt.

Tento adresár môže byť veľmi veľký, najmä ak má váš projekt veľa závislostí alebo niektoré závislosti majú veľké súbory. Vylúčením "node_modules" z vášho úložiska Git, môžete ho udržiavať čistý a zmenšiť jeho veľkosť.

Aby ste sa vyhli pridávaniu "node_modules" do svojho úložiska Git, pridajte jeho názov do súboru .gitignore:

#.gitignore
node_modules/

5. Súbory operačného systému

Váš operačný systém a ďalšie systémové nástroje môžu generovať súbory bežným používaním. Môžu zahŕňať protokolové súbory, dočasné súbory a systémové konfiguračné súbory. Príkladom je Thumbs.db súbor v systéme Windows a jeho ekvivalente pre macOS, .DS_Store súbor.

Vo všeobecnosti je dobrým zvykom vylúčiť súbory operačného systému z vášho úložiska Git tak, ako sú sú špecifické pre vaše miestne prostredie a môžu sa líšiť medzi rôznymi počítačmi a operačnými systémami systémov.

GitHub odporúča pokyny pre .gitignore Windows, macOS, a Linux.

Význam kontroly verzií

Používanie správy verzií môže výrazne zlepšiť váš pracovný tok a znížiť chyby a konflikty, ktoré môžu vzniknúť pri práci na kódovej základni. Pomocou správy verzií môžete jednoducho sledovať zmeny kódu, kontrolovať ich a bezproblémovo spolupracovať s členmi tímu.

Vždy by ste však mali vylúčiť určité súbory, ako sú konfiguračné súbory, súbory IDE a súbory OS. Tým sa zníži veľkosť vášho úložiska a zabezpečí sa, že neuniknú citlivé informácie.