5 failų tipai, kuriuos reikia įtraukti į .gitignore

Versijos valdymas yra gyvybiškai svarbus įrankis kodų bazės pakeitimams stebėti, tačiau ne visada norite sekti kiekvieną failą.

Kad išvengtumėte netvarkos ir sumažintumėte neskelbtinos informacijos platinimo riziką, galite naudoti failą pavadinimu .gitignore. Šis failas nurodo, kurių failų ir katalogų Git neturėtų indeksuoti.

Gali būti sudėtinga nustatyti, kuriuos failus įtraukti į .gitignore, ypač jei esate naujokas. Sužinokite, kuriuos failus turėtumėte pridėti prie .gitignore, kad Git darbo eiga būtų sklandesnė.

.gitignore failo sukūrimas

Kad jūsų .gitignore failas turėtų kokį nors poveikį, projekte turite inicijuoti Git.

Galite inicijuoti „Git“ paleisdami toliau pateiktą komandą savo terminale:

git init

Ši komanda sukuria naują „Git“ saugyklą jūsų projektui paslėptame „.git“ pakatalogyje, kuriame yra visi failai ir katalogai, kurių reikia projekto versijai valdyti.

Norėdami paleisti šią komandą, turite turėti Git įdiegtas jūsų sistemoje.

Tada sukurkite .gitignore failą vykdydami toliau pateiktą komandą:

liesti.gitignore

Vykdydami aukščiau pateiktą komandą, dabartiniame kataloge sukuriamas naujas failas „.gitignore“. Galite išskirti failą iš Git pridėdami failo pavadinimą arba failo kelią (jei failas yra kitame kataloge nei .gitignore failas).

Git nereikia sekti kiekvieno failo jūsų projekte, o kai kurių failų stebėjimas gali sukelti nenumatytų problemų. Tai yra keletas failų, kuriuos turėtumėte pridėti prie .gitignore.

1. Konfigūracijos failai

Konfigūracijos failuose saugomi nustatymai ir kiti parametrai, kuriuos jūsų programos naudoja savo elgsenai apibrėžti ir tinkinti. Šiuose failuose dažnai saugomos duomenų bazės ryšio eilutės, API raktai ir kita slapta informacija, kurios neturėtumėte atskleisti savo „Git“ saugykloje.

Jei į saugyklą įtrauksite konfigūracijos failus, visi, kurie gali ją pasiekti, gali peržiūrėti jų turinį. Tai gali apimti neskelbtiną informaciją, dėl kurios gali atsirasti saugumo pažeidimų ir kitų problemų.

Norėdami neįtraukti konfigūracijos failų iš savo Git saugyklos, pridėkite konkrečius failų pavadinimus arba aplankų pavadinimus .gitignore failą.

Pavyzdžiui, galite pridėti žemiau esančią eilutę prie savo .gitignore failą ignoruoti a .env failą.

.env

2. Sukurkite artefaktus

Sukūrimo artefaktai yra sukompiliuoti arba sugeneruoti failai, sukurti kuriant projektą. Šie failai paprastai yra a "taikinys" arba "statyti" katalogas.

Sukūrimo artefaktai gali apimti sudarytas Java klases, JAR failus, WAR failus, dvejetainius failus, platinimo paketus, ataskaitas, žurnalo failus ir kitus, sugeneruotus kūrimo proceso metu.

Paprastai gera praktika neįtraukti kūrimo artefaktų iš „Git“ saugyklos, nes jie gali būti labai dideli. Jie taip pat gali būti mažiau nešiojami nei jūsų šaltinio failai, susiję tik su konkrečia aplinka. Įtraukus juos į saugyklą, gali padidėti saugyklos dydis ir sulėtėti klonavimas bei darbas.

Norėdami neįtraukti kūrimo artefaktų iš „Git“ saugyklos, pridėkite "taikinys/" arba "statyti/" katalogą į jūsų .gitignore failą.

Pavyzdžiui:

# .gitignore
target/
statyti/

3. Integruotos kūrimo aplinkos failai

Integruotos kūrimo aplinkos (IDE) failai yra konfigūracijos failai, projekto metaduomenys ir kiti failai, kuriuos sukuria jūsų IDE, kai kuriate arba atidarote projektą. Šie failai yra būdingi kiekvienam IDE. Jūsų IDE naudoja šiuos failus projekto parametrams konfigūruoti.

Šie failai nereikalingi kuriant ar paleidžiant jūsų programą ir dažnai gali sukelti problemų, jei jie naudojami bendrai naudojamai Git saugyklai. Pavyzdžiui, skirtingi jūsų komandos žmonės gali naudoti skirtingas IDE arba versijas, o IDE specifinių failų įtraukimas gali sukelti sujungimo konfliktus ir apsunkinti bendradarbiavimą įgyvendinant projektą.

Kadangi šie failai yra specifiniai IDE, failai turi būti įtraukti į jūsų .gitignore failas priklausys nuo jūsų IDE. Čia yra GitHub .gitignore rekomendacijos kai kuriems populiariems IDE. Galite ieškoti savo pasirinktos IDE ir pridėti apibūdintus failus prie savo .gitignore failą.

4. Priklausomybės ir paketo failai

Priklausomybių ir paketų failai yra failai, kuriuose yra informacijos apie jūsų programos naudojamas priklausomybes ir paketus. Įvairūs statybos įrankiai, pvz mazgo paketų tvarkyklė (npm), sugeneruokite šiuos failus.

Pavyzdžiui, jei naudojate npm „JavaScript“ projekto priklausomybėms valdyti, jis sukurs „mazgų_moduliai“ aplanką savo projekto šakniniame kataloge. Kataloge yra visos įdiegtos jūsų projekto priklausomybės.

Šis katalogas gali tapti labai didelis, ypač jei jūsų projektas turi daug priklausomybių arba kai kurios priklausomybės turi didelių failų dydžių. Išskyrus "mazgų_moduliai" aplanką iš savo Git saugyklos, galite išlaikyti jį švarų ir sumažinti jo dydį.

Kad nepridėtų "mazgų_moduliai" katalogą į savo Git saugyklą, pridėkite jo pavadinimą prie .gitignore failo:

#.gitignore
mazgas_moduliai/

5. Operacinės sistemos failai

Jūsų operacinė sistema ir kiti sistemos įrankiai gali generuoti failus įprastai naudojant. Tai gali būti žurnalo failai, laikinieji failai ir sistemos konfigūracijos failai. Pavyzdys yra Nykštys.db failą sistemoje „Windows“ ir jos „MacOS“ atitikmenį .DS_Store failą.

Paprastai gera praktika yra neįtraukti operacinės sistemos failų iš „Git“ saugyklos, kaip jie yra būdingi jūsų vietinei aplinkai ir gali skirtis skirtinguose kompiuteriuose ir veikiant sistemos.

„GitHub“ rekomendavo .gitignore gaires Windows, macOS, ir Linux.

Versijų valdymo svarba

Versijų valdymo naudojimas gali žymiai pagerinti darbo eigą ir sumažinti klaidų bei konfliktų, kurie gali kilti dirbant su kodų baze, skaičių. Naudodami versijų valdymą galite lengvai sekti kodo pakeitimus, juos peržiūrėti ir sklandžiai bendradarbiauti su komandos nariais.

Tačiau visada turėtumėte išskirti tam tikrus failus, pvz., konfigūracijos failus, IDE failus ir OS failus. Tai sumažins saugyklos dydį ir užtikrins, kad nenutekėsite neskelbtinos informacijos.