Kaikkien projektisi tiedostojen ei pitäisi olla versioohjattuja. Selvitä, minkä tyyppiset tiedostot sinun pitäisi sulkea pois lähdevarastosta.

Versionhallinta on tärkeä työkalu koodikannan muutosten seuraamiseen, mutta et aina halua seurata jokaista tiedostoa.

Voit välttää sotkua ja vähentää arkaluonteisten tietojen leviämisen riskiä käyttämällä tiedostoa nimeltä .gitignore. Tämä tiedosto määrittää, mitä tiedostoja ja hakemistoja Git ei saa indeksoida.

.gitignore-tiedostoon sisällytettävien tiedostojen määrittäminen voi olla haaste, varsinkin jos olet uusi kehitystyössä. Selvitä, mitkä tiedostot sinun pitäisi lisätä .gitignoreen, jotta Git-työnkulku sujuisi sujuvammin.

Luodaan .gitignore-tiedosto

Jotta .gitignore-tiedostollasi olisi vaikutusta, Git on oltava alustettu projektissasi.

Voit alustaa Gitin suorittamalla alla olevan komennon päätteessäsi:

git init

Tämä komento luo projektillesi uuden Git-arkiston piilotettuun ".git"-alihakemistoon, joka sisältää kaikki tiedostot ja hakemistot, joita se tarvitsee projektin versionhallintaan.

instagram viewer

Jotta voit suorittaa tämän komennon, sinulla on oltava Git asennettuna järjestelmääsi.

Luo seuraavaksi .gitignore-tiedosto suorittamalla alla oleva komento:

kosketus.gitignore

Yllä olevan komennon suorittaminen luo uuden tiedoston ".gitignore" nykyiseen hakemistoosi. Voit jättää tiedoston pois Gitistä lisäämällä tiedostonimen tai tiedostopolun (jos tiedosto on eri hakemistossa kuin .gitignore tiedosto).

Gitin ei tarvitse seurata jokaista projektisi tiedostoa, ja joidenkin tiedostojen seuranta voi johtaa odottamattomiin ongelmiin. Nämä ovat joitain tiedostoja, jotka sinun tulee lisätä .gitignoreen.

1. Asetustiedostot

Määritystiedostot tallentavat asetukset ja muut parametrit, joita sovelluksesi käyttävät toimintansa määrittämiseen ja mukauttamiseen. Nämä tiedostot tallentavat usein tietokantayhteysmerkkijonoja, API-avaimia ja muita arkaluontoisia tietoja, joita sinun ei pitäisi paljastaa Git-varastossasi.

Jos lisäät määritystiedostoja arkistoon, kuka tahansa, jolla on pääsy siihen, voi tarkastella niiden sisältöä. Se voi sisältää arkaluontoisia tietoja, jotka voivat johtaa tietoturvaloukkauksiin ja muihin ongelmiin.

Jos haluat sulkea määritystiedostot pois Git-varastostasi, lisää tiettyjä tiedosto- tai kansionimiä tiedostoosi .gitignore tiedosto.

Voit esimerkiksi lisätä alla olevan rivin omaan .gitignore ohitettava tiedosto a .env tiedosto.

.env

2. Rakenna esineitä

Rakennusartefaktit ovat käännettyjä tai luotuja tiedostoja, jotka on tuotettu projektin rakentamisen yhteydessä. Nämä tiedostot sijaitsevat yleensä a "kohde" tai "rakentaa" hakemistosta.

Rakennusartefaktit voivat sisältää koottuja Java-luokkia, JAR-tiedostoja, WAR-tiedostoja, binääritiedostoja, jakelupaketteja, raportteja, lokitiedostoja ja muita koontiprosessin aikana luotuja.

Yleensä on hyvä käytäntö jättää koontiartefaktit pois Git-varastosta, koska ne voivat olla erittäin suuria. Ne voivat myös olla vähemmän kannettavia kuin lähdetiedostosi, ja ne voivat olla merkityksellisiä vain tietyssä ympäristössä. Niiden lisääminen arkistoon voi suurentaa arkiston kokoa ja hidastaa kloonausta ja työskentelyä.

Jos haluat sulkea pois koontiartefaktit Git-arkistostasi, lisää "kohde/" tai "rakentaa/" hakemistoon sinun .gitignore tiedosto.

Esimerkiksi:

# .gitignore
kohde/
rakentaa/

3. Integroidut kehitysympäristötiedostot

Integrated Development Environment (IDE) -tiedostot ovat konfiguraatiotiedostoja, projektin metatietoja ja muita IDE: n luomia tiedostoja, kun luot tai avaat projektin. Nämä tiedostot ovat kunkin IDE-kohtaisia. IDE käyttää näitä tiedostoja projektin asetusten määrittämiseen.

Nämä tiedostot ovat tarpeettomia sovelluksesi rakentamiseen tai suorittamiseen, ja ne voivat usein aiheuttaa ongelmia, jos ne ovat sitoutuneet jaettuun Git-tietovarastoon. Esimerkiksi tiimisi eri ihmiset voivat käyttää eri IDE: itä tai versioita, ja IDE-kohtaisten tiedostojen sitominen voi aiheuttaa yhdistämisristiriitoja ja vaikeuttaa projektin yhteistyötä.

Koska nämä tiedostot ovat IDE-spesifisiä, tiedostot sisällytettäväksi .gitignore tiedosto riippuu IDE: stäsi. Tässä ovat GitHubin .gitignore-suositukset joillekin suosituille IDE: ille. Voit etsiä haluamaasi IDE-tunnusta ja lisätä hahmotellut tiedostot omaan .gitignore tiedosto.

4. Riippuvuus- ja pakettitiedostot

Riippuvuus- ja pakettitiedostot ovat tiedostoja, jotka sisältävät tietoja sovelluksesi käyttämistä riippuvuuksista ja paketeista. Erilaisia ​​rakennustyökaluja, mm Node Package Manager (npm), luo nämä tiedostot.

Jos esimerkiksi käytät npm-komentoa JavaScript-projektin riippuvuuksien hallintaan, se luo "solmu_moduulit"-kansioon projektisi juurihakemistossa. Hakemisto sisältää kaikki projektillesi asennetut riippuvuudet.

Tästä hakemistosta voi tulla erittäin suuri, varsinkin jos projektissasi on monia riippuvuuksia tai joillakin riippuvuuksilla on suuria tiedostokokoja. Sulkemalla pois "solmu_moduulit"-kansiosta Git-arkistosta, voit pitää sen puhtaana ja pienentää sen kokoa.

Välttääksesi ""solmu_moduulit" hakemistosta Git-tietovarastoon, lisää sen nimi .gitignore-tiedostoosi:

#.gitignore
solmu_moduulit/

5. Käyttöjärjestelmän tiedostot

Käyttöjärjestelmäsi ja muut järjestelmätyökalut voivat luoda tiedostoja normaalikäytössä. Näitä voivat olla lokitiedostot, väliaikaiset tiedostot ja järjestelmän kokoonpanotiedostot. Esimerkkinä on Peukalot.db tiedosto Windowsissa ja sen macOS-vastineessa .DS_Store tiedosto.

Yleensä on hyvä käytäntö sulkea käyttöjärjestelmätiedostot pois Git-varastosta sellaisena kuin ne ovat paikalliselle ympäristöllesi ominaisia ​​ja voivat vaihdella eri tietokoneiden ja toimintojen välillä järjestelmät.

GitHub on suositellut .gitignore-ohjeita Windows, Mac käyttöjärjestelmä, ja Linux.

Versionhallinnan merkitys

Versionhallinnan käyttö voi parantaa merkittävästi työnkulkua ja vähentää virheitä ja ristiriitoja, joita voi syntyä, kun työskentelet koodikannassa. Versionhallinnan avulla voit helposti seurata koodimuutoksia, tarkastella niitä ja tehdä yhteistyötä tiimin jäsenten kanssa saumattomasti.

Sinun tulee kuitenkin aina sulkea pois tietyt tiedostot, kuten määritystiedostot, IDE-tiedostot ja käyttöjärjestelmätiedostot. Tämä pitää arkistosi koon pienenä ja varmistaa, että et vuoda arkaluonteisia tietoja.