Ignorarea fișierelor și directoarelor în git (.gitignore)

Adesea, atunci când lucrați la un proiect care utilizează Git, veți dori să excludeți fișierele sau directoarele specifice să fie împinse în depozitul la distanță.

Fișierul .gitignore specifică ce fișiere netratate Git ar trebui să ignore.

Ce fișiere ar trebui ignorate?

Fișierele ignorate sunt de obicei fișiere specifice platformei sau fișiere create automat din sistemele de construire. Câteva exemple comune includ:

• Fișiere de rulare, cum ar fi fișiere jurnal, blocare, cache sau fișiere temporare. Fișiere cu informații sensibile, cum ar fi parole sau chei API.Codul compilat, cum ar fi directoare .class sau .o .Dependență, cum ar fi /vendor /node_modules , cum ar fi /public , /out sau /dist . fișierele de sistem precum .DS_Store sau Thumbs.db fișiere de configurare IDE sau editor de text.

.gitignore

Un fișier local .gitignore este de obicei plasat în directorul rădăcină al depozitului. Cu toate acestea, puteți crea mai multe fișiere .gitignore în diferite subdirectorii din depozitul dvs. Modelele din fișierele .gitignore sunt potrivite în raport cu directorul în care se află fișierul.

Modelele definite în fișierele care se află în directoarele de nivel inferior (subdirectoare) au prioritate față de cele din directoarele de nivel superior.

Fișierele .gitignore locale sunt partajate cu alți dezvoltatori și ar trebui să conțină modele care sunt utile pentru toți ceilalți utilizatori ai depozitului.

Reguli de ignorare personale

Tiparele care sunt specifice depozitului dvs. local și nu ar trebui distribuite altor depozite, trebuie să fie setate în .git/info/exclude .

De exemplu, puteți utiliza acest fișier pentru a ignora fișierele generate din instrumentele personale ale proiectului.

Global .gitignore

Git vă permite, de asemenea, să creați un fișier .gitignore global, unde puteți defini regulile de ignorare pentru fiecare depozit Git din sistemul dvs. local.

Fișierul poate fi numit orice îți place și stocat în orice locație. Cel mai comun loc pentru a păstra acest fișier este directorul de acasă. Va trebui să creați manual fișierul și să configurați Git pentru a-l utiliza.

De exemplu, pentru a seta ~/.gitignore_global ca fișier global ignorare Git, ar face următoarele:

1. Creați fișierul:

   touch ~/.gitignore_global

   Adăugați fișierul la configurația Git:

   git config --global core.excludesfile ~/.gitignore_global

   Deschideți fișierul cu editorul de text și adăugați-vă regulile.

Regulile globale sunt deosebit de utile pentru ignorarea anumitor fișiere pe care nu doriți niciodată să le comite, cum ar fi fișiere cu informații sensibile sau executabile compilate.

Ignorând un fișier angajat anterior

Fișierele din copia dvs. de lucru pot fi urmărite sau netratate.

Pentru a ignora un fișier care a fost angajat anterior, va trebui să întrerupeți și să eliminați fișierul din index, apoi adăugați o regulă pentru fișierul în .gitignore :

git rm --cached filename

Opțiunea --cached indică git-ului să nu ștergeți fișierul din arborele de lucru, ci doar să-l elimine din index.

Pentru a elimina recursiv un director, utilizați opțiunea -r :

git rm --cached filename

Când ștergeți recursiv fișierele, utilizați opțiunea -n care va efectua o „execuție uscată” și vă va arăta ce fișiere vor fi șterse:

git rm -r -n directory

Debugging fișier .gitignore

Uneori poate fi dificil să se stabilească de ce este ignorat un anumit fișier, mai ales când utilizați mai multe fișiere .gitignore sau modele complexe. Aici este la îndemână comanda git check-ignore cu opțiunea -v , care spune că git să afișeze detalii despre modelul de potrivire.

De exemplu, pentru a verifica de ce este ignorat fișierul www/yarn.lock ați rula:

git check-ignore -v www/yarn.lock

Ieșirea arată calea către fișierul gitignore , numărul liniei potrivite și modelul real.

www/.gitignore:31:/yarn.lock www/yarn.lock

Comanda acceptă, de asemenea, mai multe nume de fișier ca argumente, iar fișierul nu trebuie să existe în arborele de lucru.

Afișarea tuturor fișierelor ignorate

Comanda git status cu opțiunea --ignored afișează o listă cu toate fișierele ignorate:

git status --ignored

Concluzie

Fișierul .gitignore vă permite să excludeți fișierele să fie verificate în depozit. Fișierul conține tipare globale care descriu ce fișiere și directoare ar trebui ignorate.

gitignore.io este un serviciu online care vă permite să generați fișiere .gitignore pentru sistemul dvs. de operare, limbajul de programare sau IDE.