Mis on .gitignore?

.gitignore defineerib Giti jaoks failid ja kaustad, mida commit-imisel ignoreerida. Sinna saad ise lisada või sealt eemaldada faile. Et ka teised Sinu projekti endale kloonivad inimesed saaksid samu eiramisreegleid kasutada, commit-i .gitignore fail enda repo-sse.

.gitignore’i lisatakse näiteks ise loodud katsetusfaile, genereeritud faile, konfidentsiaalset infot sisaldavaid faile või faile, mis on Sinu enda arvutiga seotud konfiguratsioonifailid (kõigil erinevad ja neid ei peaks commit-ima). Tihti on probleem, et projekte kloonides või setupi- tehes tulevad nt .xml, .yaml jne failid, mida teistel pole vaja, sest need genereeitakse ka neile ja on kõigi jaoks veidi erinevad.

Fail näeb välja midagi sellist:

../../_images/gitignore.png

# - kommentaar

* - vastab kõigele peale ‘/’

? - vastab ükskõik millisele üksikule märgile, peale ‘/’

! - tühistab mustri

/ - kataloogide (directory) eraldaja

**/ - otsi kõikidest kataloogidest

/** - otsi mingi kataloogi seest. Näiteks aaa/** leiab kõik failid kataloogist ‘aaa’

// - leia null või rohkem kataloogi. Näiteks ‘a//b’-le vastab ‘a/b’, ‘a/x/b’, ‘a/x/y/b’, jne

GitHub on avalikus repositooriumis ‘github/gitignore’ välja toonud listi soovituslikest failidest, mida oma projekti .gitignore-i lisada. .gitignore failid on liigitatud programmeerimiskeelte, arenduskeskkondade ja operatsioonisüsteemide alusel.

Praktiline ülesanne .gitignore kasutamise kohta

Eesmärk: Õppida, kuidas kasutada .gitignore faili, et välistada teatud failid ja kaustad Git'i jälgimisest, ning mõista selle olulisust projektide haldamisel.

Projekt, millega ülesandeid lahendada: https://gitlab.cs.ttu.ee/iti0105-2024/git-workshop

Juhised projekti kloonimiseks/forkimiseks leiad siit.

1. Juhised IDE jaoks:

.gitignore faili loomine ja seadistamine: - Loo .gitignore fail PyCharmis: - Avage oma projekt PyCharmis. - Paremklõpsake projekti juurkaustal (projektinimi Project vaates) ja valige New > File. - Sisestage failinimeks .gitignore ja vajutage Enter. - Avage äsja loodud .gitignore fail ja lisage sinna failide või kaustade nimed, mida te ei soovi Git'i jälgimisele lisada. Näiteks:

# Kõik failid, millel on .log lõpp, mida git ignoreerib
*.log

# Kindel kaust, mida git ignoreerib
minu_kaust/

# Kindel fail, mida git ignoreerib
minu_fail.txt

  • Salvesta fail (Ctrl + S).

Miks kasutada .gitignore faili:

  • Eesmärk ja kasutegurid:

    • .gitignore fail on oluline, kuna see võimaldab välistada faile ja kaustu, mida ei ole vaja Git repositooriumisse lisada, nagu näiteks:

    • Operatsioonisüsteemi loodud failid (.DS_Store, Thumbs.db).

    • Logifailid ja ajutised failid, mida genereerivad erinevad tööriistad ja keskkonnad.

    • Suured sõltuvuste kaustad, nagu node_modules/, mis võivad teha repositooriumi mahukaks ja raskesti hallatavaks.

  • .gitignore fail aitab hoida teie repositooriumi puhtana ja hallatavana, keskendudes ainult olulistele koodifailidele ja projektivaradele.

Commit'i .gitignore fail ja muudatused:

  • Kui olete .gitignore faili seadistanud ja salvestanud, lisage see Git'i jälgimisele:

    • Paremklõpsake .gitignore failil ja valige Git > Add.

    • Commit'ige .gitignore fail:

      • Paremklõpsake failil ja valige Git > Commit....

      • Sisestage commit'i sõnum (näiteks "Lisatud .gitignore fail") ja vajutage Commit.

    • Push'ige muudatused GitLab'i, valides ülemisest menüüst Git > Push....

2. Juhised terminali jaoks:

Loo .gitignore fail: - Loo fail projekti juurkausta:

touch .gitignore

  • Ava fail tekstiredaktoris ja lisa sinna reeglid. Näiteks:

*.log
secret.txt
/build

  • Commit'i .gitignore fail:

git add .gitignore
git commit -m "Lisatud .gitignore fail"
git push origin main

Näited:

  • Lisage .gitignore fail igasse projekti algusesse, et määrata kindlaks, milliseid faile ja kaustu Git ei jälgi.

  • Kasutage .gitignore faili pidevalt uuendades, kui projektis lisandub uusi faile või kaustu, mida ei ole vaja Git'i repositooriumisse lisada.

Kasutatud allikad