5 τύποι αρχείων που πρέπει να συμπεριληφθούν στο .gitignore

Ο έλεγχος έκδοσης είναι ένα ζωτικό εργαλείο για την παρακολούθηση αλλαγών στη βάση κωδίκων σας, αλλά δεν θέλετε πάντα να παρακολουθείτε κάθε αρχείο.

Για να αποφύγετε την ακαταστασία και να μειώσετε τον κίνδυνο διανομής ευαίσθητων πληροφοριών, μπορείτε να χρησιμοποιήσετε ένα αρχείο που ονομάζεται .gitignore. Αυτό το αρχείο καθορίζει ποια αρχεία και καταλόγους δεν πρέπει να ευρετηριάσει το Git.

Ο καθορισμός των αρχείων που θα συμπεριληφθούν στο .gitignore μπορεί να είναι μια πρόκληση, ειδικά αν είστε νέος στην ανάπτυξη. Μάθετε ποια αρχεία πρέπει να προσθέσετε στο .gitignore για μια πιο ομαλή ροή εργασίας Git.

Δημιουργία αρχείου .gitignore

Για να έχει οποιοδήποτε αποτέλεσμα το αρχείο σας .gitignore, πρέπει να έχετε προετοιμάσει το Git στο έργο σας.

Μπορείτε να αρχικοποιήσετε το Git εκτελώντας την παρακάτω εντολή στο τερματικό σας:

git init

Αυτή η εντολή δημιουργεί ένα νέο αποθετήριο Git για το έργο σας, σε έναν κρυφό υποκατάλογο ".git" που περιέχει όλα τα αρχεία και τους καταλόγους που χρειάζεται για τον έλεγχο έκδοσης του έργου σας.

Για να εκτελέσετε αυτήν την εντολή, πρέπει να έχετε Το Git είναι εγκατεστημένο στο σύστημά σας.

Στη συνέχεια, δημιουργήστε το αρχείο .gitignore εκτελώντας την παρακάτω εντολή:

αφή.gitignore

Εκτελώντας την παραπάνω εντολή δημιουργείται ένα νέο αρχείο, ".gitignore" στον τρέχοντα κατάλογο σας. Μπορείτε να εξαιρέσετε ένα αρχείο από το Git προσθέτοντας το όνομα αρχείου ή τη διαδρομή του αρχείου (εάν το αρχείο βρίσκεται σε διαφορετικό κατάλογο από τον .gitignore αρχείο).

Το Git δεν χρειάζεται να παρακολουθεί κάθε αρχείο στο έργο σας και η παρακολούθηση ορισμένων αρχείων μπορεί να οδηγήσει σε απρόβλεπτα προβλήματα. Αυτά είναι μερικά από τα αρχεία που πρέπει να προσθέσετε στο .gitignore σας.

1. Αρχεία Διαμόρφωσης

Τα αρχεία διαμόρφωσης αποθηκεύουν ρυθμίσεις και άλλες παραμέτρους που χρησιμοποιούν οι εφαρμογές σας για να ορίσουν και να προσαρμόσουν τη συμπεριφορά τους. Αυτά τα αρχεία συχνά αποθηκεύουν συμβολοσειρές σύνδεσης βάσης δεδομένων, κλειδιά API και άλλες ευαίσθητες πληροφορίες που δεν πρέπει να εκθέσετε στο αποθετήριο Git.

Εάν συμπεριλάβετε αρχεία διαμόρφωσης στο αποθετήριο σας, οποιοσδήποτε έχει πρόσβαση σε αυτό μπορεί να δει τα περιεχόμενά του. Αυτό μπορεί να περιλαμβάνει ευαίσθητες πληροφορίες, οι οποίες μπορεί να οδηγήσουν σε παραβιάσεις ασφάλειας και άλλα ζητήματα.

Για να εξαιρέσετε αρχεία διαμόρφωσης από το αποθετήριο Git, προσθέστε συγκεκριμένα ονόματα αρχείων ή ονόματα φακέλων στο .gitignore αρχείο.

Για παράδειγμα, μπορείτε να προσθέσετε την παρακάτω γραμμή στο δικό σας .gitignore αρχείο για να αγνοήσει α .env αρχείο.

.env

2. Κατασκευάστε τεχνουργήματα

Τα τεχνουργήματα κατασκευής είναι τα μεταγλωττισμένα ή δημιουργημένα αρχεία που παράγονται κατά τη δημιουργία του έργου σας. Αυτά τα αρχεία συνήθως ζουν σε ένα "στόχος" ή "χτίζω" Ευρετήριο.

Τα τεχνουργήματα κατασκευής μπορούν να περιλαμβάνουν μεταγλωττισμένες τάξεις Java, αρχεία JAR, αρχεία WAR, δυαδικά αρχεία, πακέτα διανομής, αναφορές, αρχεία καταγραφής και άλλα που δημιουργούνται κατά τη διαδικασία κατασκευής.

Είναι γενικά καλή πρακτική να αποκλείετε τα τεχνουργήματα κατασκευής από το αποθετήριο Git επειδή μπορεί να είναι πολύ μεγάλα. Μπορεί επίσης να είναι λιγότερο φορητά από τα αρχεία προέλευσης, μόνο σχετικά με ένα συγκεκριμένο περιβάλλον. Η συμπερίληψή τους στο αποθετήριο σας μπορεί να διογκώσει το μέγεθος του αποθετηρίου σας και να το κάνει πιο αργό στην κλωνοποίηση και την εργασία μαζί του.

Για να εξαιρέσετε τεχνουργήματα κατασκευής από το αποθετήριο Git, προσθέστε το "στόχος/" ή "χτίζω/" κατάλογο στο δικό σας .gitignore αρχείο.

Για παράδειγμα:

# .gitignore
στόχος/
χτίζω/

3. Ενσωματωμένα Αρχεία Περιβάλλοντος Ανάπτυξης

Τα αρχεία Integrated Development Environment (IDE) είναι αρχεία διαμόρφωσης, μεταδεδομένα έργου και άλλα αρχεία που δημιουργούνται από το IDE σας όταν δημιουργείτε ή ανοίγετε ένα έργο. Αυτά τα αρχεία είναι συγκεκριμένα για κάθε IDE. Το IDE σας χρησιμοποιεί αυτά τα αρχεία για να διαμορφώσει τις ρυθμίσεις του έργου.

Αυτά τα αρχεία δεν είναι απαραίτητα για τη δημιουργία ή την εκτέλεση της εφαρμογής σας και συχνά μπορούν να προκαλέσουν προβλήματα εάν δεσμευτούν σε έναν κοινόχρηστο χώρο αποθήκευσης Git. Για παράδειγμα, διαφορετικά άτομα στην ομάδα σας μπορεί να χρησιμοποιούν διαφορετικά IDE ή εκδόσεις και η δέσμευση αρχείων που αφορούν συγκεκριμένα IDE θα μπορούσε να προκαλέσει συγκρούσεις συγχώνευσης και να δυσχεράνει τη συνεργασία στο έργο.

Δεδομένου ότι αυτά τα αρχεία είναι ειδικά για IDE, τα αρχεία που πρέπει να συμπεριλάβετε στο δικό σας .gitignore αρχείο θα εξαρτηθεί από το IDE σας. Εδώ είναι Οι προτάσεις .gitignore του GitHub για ορισμένα δημοφιλή IDE. Μπορείτε να αναζητήσετε το IDE της επιλογής σας και να προσθέσετε τα περιγραφόμενα αρχεία στο δικό σας .gitignore αρχείο.

4. Αρχεία Εξάρτησης και Πακέτων

Τα αρχεία εξάρτησης και πακέτων είναι αρχεία που περιέχουν πληροφορίες σχετικά με τις εξαρτήσεις και τα πακέτα που χρησιμοποιούνται από την εφαρμογή σας. Διάφορα εργαλεία κατασκευής, όπως π.χ το Node Package Manager (npm), δημιουργήστε αυτά τα αρχεία.

Για παράδειγμα, εάν χρησιμοποιείτε npm για τη διαχείριση εξαρτήσεων για ένα έργο JavaScript, θα δημιουργήσει ένα "node_modules" στον ριζικό κατάλογο του έργου σας. Ο κατάλογος περιέχει όλες τις εγκατεστημένες εξαρτήσεις για το έργο σας.

Αυτός ο κατάλογος μπορεί να γίνει πολύ μεγάλος, ειδικά εάν το έργο σας έχει πολλές εξαρτήσεις ή ορισμένες εξαρτήσεις έχουν μεγάλα μεγέθη αρχείων. Εξαιρώντας το "node_modules" από το αποθετήριο Git, μπορείτε να τον διατηρήσετε καθαρό και να μειώσετε το μέγεθός του.

Για να αποφύγετε την προσθήκη του "node_modules" κατάλογο στο αποθετήριο Git, προσθέστε το όνομά του στο αρχείο .gitignore:

#.gitignore
node_modules/

5. Αρχεία λειτουργικού συστήματος

Το λειτουργικό σας σύστημα και άλλα εργαλεία συστήματος ενδέχεται να δημιουργήσουν αρχεία μέσω κανονικής χρήσης. Αυτά μπορεί να περιλαμβάνουν αρχεία καταγραφής, προσωρινά αρχεία και αρχεία διαμόρφωσης συστήματος. Ένα παράδειγμα είναι το Thumbs.db αρχείο στα Windows και το αντίστοιχο macOS, το .DS_Store αρχείο.

Είναι γενικά μια καλή πρακτική να αποκλείετε αρχεία λειτουργικού συστήματος από το αποθετήριο Git σας, όπως αυτά είναι συγκεκριμένα για το τοπικό σας περιβάλλον και μπορεί να διαφέρουν μεταξύ διαφορετικών υπολογιστών και λειτουργιών συστήματα.

Το GitHub έχει προτείνει οδηγίες .gitignore για Windows, macOS, και Linux.

Η σημασία του ελέγχου έκδοσης

Η χρήση του ελέγχου έκδοσης μπορεί να βελτιώσει σημαντικά τη ροή εργασίας σας και να μειώσει τα σφάλματα και τις διενέξεις που μπορεί να προκύψουν κατά την εργασία σε μια βάση κώδικα. Με τον έλεγχο έκδοσης, μπορείτε εύκολα να παρακολουθείτε τις αλλαγές κώδικα, να τις ελέγξετε και να συνεργαστείτε με τα μέλη της ομάδας απρόσκοπτα.

Ωστόσο, θα πρέπει πάντα να εξαιρείτε ορισμένα αρχεία, όπως αρχεία διαμόρφωσης, αρχεία IDE και αρχεία λειτουργικού συστήματος. Αυτό θα διατηρήσει το μέγεθος του αποθετηρίου σας χαμηλό και θα διασφαλίσει ότι δεν θα διαρρεύσετε ευαίσθητες πληροφορίες.