5 tipuri de fișiere de inclus în .gitignore

Controlul versiunilor este un instrument vital pentru urmărirea modificărilor la baza de cod, dar nu doriți să urmăriți întotdeauna fiecare fișier.

Pentru a evita aglomerația și a reduce riscul de a distribui informații sensibile, puteți utiliza un fișier numit .gitignore. Acest fișier specifică ce fișiere și directoare nu ar trebui să indexeze Git.

Determinarea ce fișiere să includă în .gitignore poate fi o provocare, mai ales dacă sunteți nou în dezvoltare. Aflați ce fișiere ar trebui să adăugați la .gitignore pentru un flux de lucru Git mai fluid.

Crearea unui fișier .gitignore

Pentru ca fișierul dvs. .gitignore să aibă efect, trebuie să aveți Git inițializat în proiect.

Puteți inițializa Git rulând comanda de mai jos în terminalul dvs.:

git init

Această comandă creează un nou depozit Git pentru proiectul tău, într-un subdirector ascuns „.git” care conține toate fișierele și directoarele de care are nevoie pentru a controla versiunea proiectului.

Pentru a rula această comandă, trebuie să aveți Git instalat în sistemul dvs.

Apoi, creați fișierul .gitignore executând comanda de mai jos:

atingere.gitignore

Rularea comenzii de mai sus creează un fișier nou, „.gitignore” în directorul curent. Puteți exclude un fișier din Git adăugând numele fișierului sau calea fișierului (dacă fișierul se află într-un director diferit de .gitignore fişier).

Git nu trebuie să urmărească fiecare fișier din proiectul dvs., iar urmărirea unor fișiere poate duce la probleme neprevăzute. Acestea sunt câteva dintre fișierele pe care ar trebui să le adăugați la .gitignore.

1. Fișiere de configurare

Fișierele de configurare stochează setările și alți parametri pe care aplicațiile dvs. îi folosesc pentru a-și defini și personaliza comportamentul. Aceste fișiere stochează adesea șiruri de conexiune la baza de date, chei API și alte informații sensibile pe care nu ar trebui să le expuneți în depozitul dvs. Git.

Dacă includeți fișiere de configurare în depozitul dvs., oricine le poate accesa își poate vedea conținutul. Acestea pot include informații sensibile, care pot duce la încălcări de securitate și alte probleme.

Pentru a exclude fișierele de configurare din depozitul dvs. Git, adăugați nume de fișiere specifice sau nume de foldere la dvs .gitignore fişier.

De exemplu, puteți adăuga linia de mai jos la dvs .gitignore fișier pentru a ignora a .env fişier.

.env

2. Construiți artefacte

Artefactele de compilare sunt fișierele compilate sau generate, produse atunci când vă construiți proiectul. Aceste fișiere trăiesc de obicei într-un "ţintă" sau "construi" director.

Artefactele de compilare pot include clase Java compilate, fișiere JAR, fișiere WAR, fișiere binare, pachete de distribuție, rapoarte, fișiere jurnal și altele generate în timpul procesului de construire.

În general, este o practică bună să excludeți artefactele de construcție din depozitul dvs. Git, deoarece acestea pot fi foarte mari. Ele pot fi, de asemenea, mai puțin portabile decât fișierele sursă, relevante doar pentru un anumit mediu. Includerea acestora în depozitul dvs. poate mări dimensiunea depozitului dvs. și poate face mai lent clonarea și lucrul cu ele.

Pentru a exclude artefactele de compilare din depozitul dvs. Git, adăugați "ţintă/" sau "construi/" directorul dvs .gitignore fişier.

De exemplu:

# .gitignore
ţintă/
construi/

3. Fișiere de mediu de dezvoltare integrate

Fișierele IDE (Integrated Development Environment) sunt fișiere de configurare, metadate ale proiectului și alte fișiere generate de IDE atunci când creați sau deschideți un proiect. Aceste fișiere sunt specifice fiecărui IDE. IDE-ul dumneavoastră folosește aceste fișiere pentru a configura setările proiectului.

Aceste fișiere nu sunt necesare pentru construirea sau rularea aplicației dvs. și pot cauza adesea probleme dacă sunt trimise într-un depozit Git partajat. De exemplu, diferiți oameni din echipa ta ar putea folosi diferite IDE-uri sau versiuni, iar comiterea fișierelor specifice IDE-ului poate cauza conflicte de îmbinare și poate îngreuna colaborarea la proiect.

Deoarece aceste fișiere sunt specifice IDE, fișierele trebuie incluse în fișierul dvs .gitignore fișierul va depinde de IDE-ul dvs. Aici sunt Recomandările .gitignore ale GitHub pentru unele IDE-uri populare. Puteți căuta IDE-ul dorit și puteți adăuga fișierele subliniate la dvs .gitignore fişier.

4. Fișiere de dependență și pachet

Fișierele de dependență și pachete sunt fișiere care conțin informații despre dependențele și pachetele utilizate de aplicația dvs. Diverse instrumente de construcție, cum ar fi Managerul de pachete Node (npm), generați aceste fișiere.

De exemplu, dacă utilizați npm pentru a gestiona dependențele pentru un proiect JavaScript, va crea un "module_noduri" folderul din directorul rădăcină al proiectului. Directorul conține toate dependențele instalate pentru proiectul dvs.

Acest director poate deveni foarte mare, mai ales dacă proiectul tău are multe dependențe sau unele dependențe au dimensiuni mari ale fișierelor. Prin excluderea „module_noduri" din depozitul dvs. Git, îl puteți păstra curat și îi puteți reduce dimensiunea.

Pentru a evita adăugarea „module_noduri" directorul în depozitul dvs. Git, adăugați numele acestuia în fișierul dvs. .gitignore:

#.gitignore
module_nod/

5. Fișierele sistemului de operare

Sistemul dvs. de operare și alte instrumente de sistem pot genera fișiere prin utilizarea normală. Acestea pot include fișiere jurnal, fișiere temporare și fișiere de configurare a sistemului. Un exemplu este Thumbs.db fișier pe Windows și echivalentul său macOS, the .DS_Store fişier.

În general, este o practică bună să excludeți fișierele sistemului de operare din depozitul dvs. Git, așa cum sunt acestea sunt specifice mediului dumneavoastră local și pot diferi între diferite computere și operare sisteme.

GitHub a recomandat liniile directoare .gitignore pentru Windows, macOS, și Linux.

Importanța controlului versiunilor

Utilizarea controlului versiunilor vă poate îmbunătăți în mod semnificativ fluxul de lucru și poate reduce erorile și conflictele care pot apărea atunci când lucrați pe o bază de cod. Cu controlul versiunilor, puteți urmări cu ușurință modificările codului, le puteți revizui și puteți colabora cu membrii echipei fără probleme.

Cu toate acestea, ar trebui să excludeți întotdeauna anumite fișiere, cum ar fi fișierele de configurare, fișierele IDE și fișierele OS. Acest lucru va menține dimensiunea depozitului dvs. redusă și va asigura că nu veți scurge informații sensibile.