5 .gitignore fájltípus

A verziókezelés létfontosságú eszköz a kódbázis változásainak nyomon követéséhez, de nem mindig akar minden fájlt nyomon követni.

A rendetlenség elkerülése és az érzékeny információk terjesztésének kockázatának csökkentése érdekében használhatja a .gitignore nevű fájlt. Ez a fájl határozza meg, hogy a Git mely fájlokat és könyvtárakat nem indexelheti.

Kihívást jelenthet annak meghatározása, hogy mely fájlok szerepeljenek a .gitignore fájlban, különösen akkor, ha még nem ismeri a fejlesztést. Tudja meg, mely fájlokat kell hozzáadnia a .gitignore fájlhoz a simább Git-munkafolyamat érdekében.

.gitignore fájl létrehozása

Ahhoz, hogy a .gitignore fájlnak bármilyen hatása legyen, inicializálnia kell a Git-et a projektben.

A Git inicializálásához futtassa az alábbi parancsot a terminálon:

git init

Ez a parancs egy új Git-tárat hoz létre a projekthez egy rejtett „.git” alkönyvtárban, amely tartalmazza a projekt verzióvezérléséhez szükséges összes fájlt és könyvtárat.

A parancs futtatásához rendelkeznie kell A Git telepítve van a rendszeredben.

Ezután hozza létre a .gitignore fájlt az alábbi parancs futtatásával:

érintés.gitignore

A fenti parancs futtatása egy új „.gitignore” fájlt hoz létre az aktuális könyvtárban. Kizárhat egy fájlt a Gitből a fájlnév vagy az elérési út hozzáadásával (ha a fájl más könyvtárban van, mint a .gitignore fájl).

A Gitnek nem kell minden fájlt nyomon követnie a projektben, és egyes fájlok nyomon követése előre nem látható problémákhoz vezethet. Íme néhány fájl, amelyet hozzá kell adnia a .gitignore fájlhoz.

1. Konfigurációs fájlok

A konfigurációs fájlok olyan beállításokat és egyéb paramétereket tárolnak, amelyeket az alkalmazások viselkedésük meghatározására és testreszabására használnak. Ezek a fájlok gyakran tárolnak adatbázis-kapcsolati karakterláncokat, API-kulcsokat és egyéb bizalmas információkat, amelyeket nem szabad közzétennie a Git-tárhelyen.

Ha konfigurációs fájlokat is tartalmaz az adattárban, bárki, aki hozzáfér, megtekintheti azok tartalmát. Ez érzékeny információkat is tartalmazhat, amelyek biztonsági résekhez és egyéb problémákhoz vezethetnek.

Ha ki szeretné zárni a konfigurációs fájlokat a Git-tárhelyből, adjon hozzá adott fájlneveket vagy mappaneveket .gitignore fájlt.

Például hozzáadhatja az alábbi sort a sajátjához .gitignore fájl figyelmen kívül hagyásához a .env fájlt.

.env

2. Építsen leleteket

Az összeállítási műtermékek a projekt összeállításakor előállított, összeállított vagy generált fájlok. Ezek a fájlok általában a "cél" vagy "épít" Könyvtár.

Az összeállítási melléktermékek tartalmazhatnak lefordított Java-osztályokat, JAR-fájlokat, WAR-fájlokat, bináris fájlokat, terjesztési csomagokat, jelentéseket, naplófájlokat és más, a felépítési folyamat során keletkezett összetevőket.

Általában célszerű kizárni az összeállítási műtermékeket a Git-tárházból, mert nagyon nagyok lehetnek. Lehetséges, hogy kevésbé hordozhatóak, mint a forrásfájlok, és csak egy adott környezetre vonatkoznak. Ha felveszi őket a tárhelybe, az megnövelheti a tár méretét, és lelassítja a klónozást és a vele való munkát.

Ha ki szeretné zárni az összeállítási melléktermékeket a Git-tárházból, adja hozzá a "cél/" vagy "épít/" címtárat az Ön számára .gitignore fájlt.

Például:

# .gitignore
cél/
épít/

3. Integrált fejlesztési környezet fájlok

Az Integrated Development Environment (IDE) fájlok konfigurációs fájlok, projekt metaadatai és egyéb fájlok, amelyeket az IDE generál a projekt létrehozásakor vagy megnyitásakor. Ezek a fájlok minden IDE-re jellemzőek. Az IDE ezeket a fájlokat használja a projektbeállítások konfigurálásához.

Ezek a fájlok szükségtelenek az alkalmazás felépítéséhez vagy futtatásához, és gyakran problémákat okozhatnak, ha egy megosztott Git-tárolóhoz kötődnek. Például a csapat különböző tagjai különböző IDE-ket vagy verziókat használhatnak, és az IDE-specifikus fájlok véglegesítése összevonási ütközéseket okozhat, és megnehezítheti a projekten való együttműködést.

Mivel ezek a fájlok IDE-specifikusak, azokat a fájlokat kell tartalmaznia .gitignore fájl az IDE-től függ. Itt vannak A GitHub .gitignore ajánlásai néhány népszerű IDE esetében. Megkeresheti a választott IDE-jét, és hozzáadhatja a vázolt fájlokat a sajátjához .gitignore fájlt.

4. Függőség- és csomagfájlok

A függőségi és csomagfájlok olyan fájlok, amelyek információkat tartalmaznak az alkalmazás által használt függőségekről és csomagokról. Különféle építőeszközök, mint pl a Node Package Manager (npm), hozza létre ezeket a fájlokat.

Ha például az npm-et használja egy JavaScript-projekt függőségének kezelésére, akkor az létrehoz egy "node_modules" mappába a projekt gyökérkönyvtárában. A könyvtár tartalmazza a projekt összes telepített függőségét.

Ez a könyvtár nagyon nagyra nőhet, különösen, ha a projektnek sok függősége van, vagy egyes függőségek nagy fájlmérettel rendelkeznek. Kizárva a "node_modules" mappát a Git tárolójából, tisztán tarthatja és csökkentheti a méretét.

A "node_modules" könyvtárba a Git tárhelybe, adja hozzá a nevét a .gitignore fájlhoz:

#.gitignore
node_modules/

5. Operációs rendszer fájlok

Az Ön operációs rendszere és más rendszereszközei normál használat során fájlokat generálhatnak. Ezek lehetnek naplófájlok, ideiglenes fájlok és rendszerkonfigurációs fájlok. Példa erre a Hüvelykujj.db fájl Windows rendszeren és macOS megfelelője, a .DS_Store fájlt.

Általában jó gyakorlat, ha az operációs rendszer fájljait kizárja a Git-tárházból, ahogy azok a helyi környezetre jellemzőek, és eltérőek lehetnek a különböző számítógépeken és működési módokon rendszerek.

A GitHub a .gitignore-ra vonatkozó irányelveket javasolta ablakok, Mac operációs rendszer, és Linux.

A verzióellenőrzés jelentősége

A verziókezelés használatával jelentősen javítható a munkafolyamat, és csökkenthető a kódbázison végzett munka során felmerülő hibák és konfliktusok száma. A verzióvezérléssel egyszerűen nyomon követheti a kódváltozásokat, áttekintheti azokat, és zökkenőmentesen együttműködhet a csapattagokkal.

Bizonyos fájlokat azonban mindig ki kell zárni, például konfigurációs fájlokat, IDE fájlokat és operációs rendszer fájlokat. Ez csökkenti a tárhely méretét, és biztosítja, hogy ne szivárogtasson ki érzékeny információkat.