5 failitüüpi, mida .gitignore'i lisada

Versioonikontroll on oluline tööriist koodibaasi muudatuste jälgimiseks, kuid te ei soovi alati jälgida iga faili.

Segaduse vältimiseks ja tundliku teabe levitamise riski vähendamiseks võite kasutada faili nimega .gitignore. See fail määrab, milliseid faile ja katalooge Git ei tohiks indekseerida.

Failide kindlaksmääramine failis .gitignore võib olla keeruline, eriti kui olete arenduses uus. Uurige välja, millised failid peaksite Giti-töövoo sujuvamaks muutmiseks .gitignore'i lisama.

.gitignore faili loomine

Et teie .gitignore-failil oleks mingit mõju, peab teie projektis olema Git lähtestatud.

Giti saate lähtestada, käivitades oma terminalis alloleva käsu:

git init

See käsk loob teie projekti jaoks uue Giti hoidla peidetud „.git” alamkataloogis, mis sisaldab kõiki teie projekti versioonikontrolliks vajalikke faile ja katalooge.

Selle käsu käivitamiseks peab teil olema Git on teie süsteemi installitud.

Järgmiseks looge oma .gitignore fail, käivitades alloleva käsu:

puudutada.gitignoreeri

Ülaltoodud käsu käivitamine loob teie praeguses kataloogis uue faili ".gitignore". Saate faili Gitist välja jätta, lisades faili nime või failitee (kui fail asub teisest kataloogist .gitignoreeri fail).

Git ei pea jälgima kõiki teie projekti faile ja mõne faili jälgimine võib põhjustada ettenägematuid probleeme. Need on mõned failid, mida peaksite failile .gitignore lisama.

1. Konfiguratsioonifailid

Konfiguratsioonifailid salvestavad sätteid ja muid parameetreid, mida teie rakendused kasutavad oma käitumise määratlemiseks ja kohandamiseks. Need failid salvestavad sageli andmebaasi ühenduse stringe, API võtmeid ja muud tundlikku teavet, mida te ei tohiks oma Giti hoidlas paljastada.

Kui lisate hoidlasse konfiguratsioonifailid, saavad kõik, kellel on sellele juurdepääs, nende sisu vaadata. See võib hõlmata tundlikku teavet, mis võib põhjustada turvarikkumisi ja muid probleeme.

Konfiguratsioonifailide Giti hoidlast väljajätmiseks lisage oma failile kindlad faili- või kaustanimed .gitignoreeri faili.

Näiteks saate lisada alloleva rea ​​oma .gitignoreeri faili ignoreerida a .env faili.

.env

2. Ehitage esemeid

Ehitusartefaktid on projekti koostamisel koostatud või loodud failid. Need failid asuvad tavaliselt a "sihtmärk" või "ehitada" kataloog.

Järgude artefaktid võivad hõlmata kompileeritud Java-klasse, JAR-faile, WAR-faile, binaarfaile, levipakette, aruandeid, logifaile ja muud, mis on koostamise käigus genereeritud.

Üldiselt on hea tava jätta oma Giti hoidlast välja ehitusartefaktid, kuna need võivad olla väga suured. Need võivad olla ka vähem kaasaskantavad kui teie lähtefailid, mis on asjakohased ainult konkreetse keskkonna jaoks. Nende hoidlasse kaasamine võib teie hoidla suurust suurendada ning selle kloonimise ja töötamise aeglasemaks muuta.

Ehitamise artefaktide välistamiseks oma Giti hoidlast lisage "sihtmärk/" või "ehitada/" kataloog teie juurde .gitignoreeri faili.

Näiteks:

# .gitignore
sihtmärk/
ehitada/

3. Integreeritud arenduskeskkonna failid

Integreeritud arenduskeskkonna (IDE) failid on konfiguratsioonifailid, projekti metaandmed ja muud failid, mille teie IDE loob projekti loomisel või avamisel. Need failid on iga IDE jaoks spetsiifilised. Teie IDE kasutab neid faile projekti sätete konfigureerimiseks.

Need failid pole teie rakenduse loomiseks või käitamiseks vajalikud ja võivad sageli põhjustada probleeme, kui need on seotud jagatud Giti hoidlaga. Näiteks võivad teie meeskonna erinevad inimesed kasutada erinevaid IDE-sid või versioone ning IDE-spetsiifiliste failide sisestamine võib põhjustada liitmiskonflikte ja raskendada projekti kallal koostööd.

Kuna need failid on IDE-spetsiifilised, lisatakse failid teie .gitignoreeri fail sõltub teie IDE-st. Siin on GitHubi .gitignore soovitused mõne populaarse IDE jaoks. Saate otsida oma valitud IDE-d ja lisada visandatud failid oma .gitignoreeri faili.

4. Sõltuvus- ja paketifailid

Sõltuvus- ja paketifailid on failid, mis sisaldavad teavet teie rakenduse kasutatavate sõltuvuste ja pakettide kohta. Erinevad ehitustööriistad, nt sõlmede paketihaldur (npm), genereerige need failid.

Näiteks kui kasutate npm-i JavaScripti projekti sõltuvuste haldamiseks, loob see "node_modules" kausta oma projekti juurkataloogis. Kataloog sisaldab kõiki teie projekti installitud sõltuvusi.

See kataloog võib muutuda väga suureks, eriti kui teie projektil on palju sõltuvusi või mõnel sõltuvusel on suured failimahud. Välistades "node_modules" kausta oma Giti hoidlast, saate selle puhtana hoida ja selle suurust vähendada.

Et mitte lisada "node_modules" kataloogi oma Giti hoidlasse, lisage selle nimi oma .gitignore-failile:

#.gitignoreeri
node_modules/

5. Operatsioonisüsteemi failid

Teie operatsioonisüsteem ja muud süsteemitööriistad võivad tavapärasel kasutamisel faile luua. Need võivad hõlmata logifaile, ajutisi faile ja süsteemi konfiguratsioonifaile. Näiteks on Pöidlad.db faili Windowsis ja selle macOS-i ekvivalendis .DS_Store faili.

Üldiselt on hea tava jätta operatsioonisüsteemi failid oma Giti hoidlast välja, nagu need on spetsiifilised teie kohalikule keskkonnale ja võivad eri arvutites ja töörežiimides erineda süsteemid.

GitHub on soovitanud .gitignore juhiseid Windows, macOSja Linux.

Versioonikontrolli tähtsus

Versioonihalduse kasutamine võib teie töövoogu oluliselt parandada ning vähendada vigu ja konflikte, mis võivad koodibaasiga töötades tekkida. Versioonihalduse abil saate hõlpsalt koodimuudatusi jälgida, neid üle vaadata ja meeskonnaliikmetega sujuvalt koostööd teha.

Siiski peaksite alati välistama teatud failid, nagu konfiguratsioonifailid, IDE-failid ja OS-failid. See hoiab teie hoidla mahtu väiksemana ja tagab, et te ei leki tundlikku teavet.