5 Dateitypen, die Sie in Ihre .gitignore-Datei aufnehmen können

Die Versionskontrolle ist ein wichtiges Tool zum Nachverfolgen von Änderungen an Ihrer Codebasis, aber Sie möchten nicht immer jede Datei nachverfolgen.

Um Unordnung zu vermeiden und das Risiko der Verbreitung vertraulicher Informationen zu verringern, können Sie eine Datei namens .gitignore verwenden. Diese Datei gibt an, welche Dateien und Verzeichnisse Git nicht indizieren soll.

Die Bestimmung, welche Dateien in .gitignore aufgenommen werden sollen, kann eine Herausforderung sein, insbesondere wenn Sie neu in der Entwicklung sind. Finden Sie heraus, welche Dateien Sie für einen reibungsloseren Git-Workflow zu Ihrer .gitignore-Datei hinzufügen sollten.

Erstellen einer .gitignore-Datei

Damit Ihre .gitignore-Datei Wirkung zeigt, muss Git in Ihrem Projekt initialisiert sein.

Sie können Git initialisieren, indem Sie den folgenden Befehl in Ihrem Terminal ausführen:

git init

Dieser Befehl erstellt ein neues Git-Repository für Ihr Projekt in einem versteckten „.git“-Unterverzeichnis, das alle Dateien und Verzeichnisse enthält, die für die Versionskontrolle Ihres Projekts erforderlich sind.

Um diesen Befehl auszuführen, müssen Sie Git auf Ihrem System installiert.

Erstellen Sie als Nächstes Ihre .gitignore-Datei, indem Sie den folgenden Befehl ausführen:

berühren.gitignorieren

Wenn Sie den obigen Befehl ausführen, wird eine neue Datei „.gitignore“ in Ihrem aktuellen Verzeichnis erstellt. Sie können eine Datei von Git ausschließen, indem Sie den Dateinamen oder den Dateipfad hinzufügen (wenn sich die Datei in einem anderen Verzeichnis als der .gitignorieren Datei).

Git muss nicht jede Datei in Ihrem Projekt nachverfolgen, und das Nachverfolgen einiger Dateien kann zu unvorhergesehenen Problemen führen. Dies sind einige der Dateien, die Sie zu Ihrer .gitignore-Datei hinzufügen sollten.

1. Konfigurationsdateien

Konfigurationsdateien speichern Einstellungen und andere Parameter, die Ihre Anwendungen verwenden, um ihr Verhalten zu definieren und anzupassen. Diese Dateien speichern häufig Datenbankverbindungszeichenfolgen, API-Schlüssel und andere vertrauliche Informationen, die Sie nicht in Ihrem Git-Repository offenlegen sollten.

Wenn Sie Konfigurationsdateien in Ihr Repository aufnehmen, kann jeder, der darauf zugreifen kann, deren Inhalt anzeigen. Dazu können sensible Informationen gehören, die zu Sicherheitsverletzungen und anderen Problemen führen können.

Um Konfigurationsdateien aus Ihrem Git-Repository auszuschließen, fügen Sie bestimmte Dateinamen oder Ordnernamen zu Ihrem hinzu .gitignorieren Datei.

Sie können beispielsweise die folgende Zeile zu Ihrer hinzufügen .gitignorieren Datei zu ignorieren a .env Datei.

.env

2. Baue Artefakte

Buildartefakte sind die kompilierten oder generierten Dateien, die beim Erstellen Ihres Projekts erstellt werden. Diese Dateien befinden sich normalerweise in einem "Ziel" oder "bauen" Verzeichnis.

Build-Artefakte können kompilierte Java-Klassen, JAR-Dateien, WAR-Dateien, Binärdateien, Distributionspakete, Berichte, Protokolldateien und andere enthalten, die während des Build-Prozesses generiert werden.

Es empfiehlt sich im Allgemeinen, Build-Artefakte aus Ihrem Git-Repository auszuschließen, da sie sehr groß sein können. Sie sind möglicherweise auch weniger portabel als Ihre Quelldateien und nur für eine bestimmte Umgebung relevant. Sie in Ihr Repository aufzunehmen, kann die Größe Ihres Repositorys aufblähen und das Klonen und Arbeiten damit verlangsamen.

Um Build-Artefakte aus Ihrem Git-Repository auszuschließen, fügen Sie die "Ziel/" oder "bauen/" Verzeichnis zu Ihrem .gitignorieren Datei.

Zum Beispiel:

# .gitignore
Ziel/
bauen/

3. Integrierte Entwicklungsumgebungsdateien

IDE-Dateien (Integrated Development Environment) sind Konfigurationsdateien, Projektmetadaten und andere Dateien, die von Ihrer IDE generiert werden, wenn Sie ein Projekt erstellen oder öffnen. Diese Dateien sind für jede IDE spezifisch. Ihre IDE verwendet diese Dateien, um die Projekteinstellungen zu konfigurieren.

Diese Dateien sind zum Erstellen oder Ausführen Ihrer Anwendung nicht erforderlich und können häufig Probleme verursachen, wenn sie in ein gemeinsam genutztes Git-Repository übernommen werden. Beispielsweise könnten verschiedene Personen in Ihrem Team unterschiedliche IDEs oder Versionen verwenden, und das Festschreiben IDE-spezifischer Dateien könnte Zusammenführungskonflikte verursachen und die Zusammenarbeit am Projekt erschweren.

Da diese Dateien IDE-spezifisch sind, müssen die Dateien in Ihre .gitignorieren Datei hängt von Ihrer IDE ab. Hier sind .gitignore-Empfehlungen von GitHub für einige beliebte IDEs. Sie können nach der IDE Ihrer Wahl suchen und die skizzierten Dateien zu Ihrer hinzufügen .gitignorieren Datei.

4. Abhängigkeits- und Paketdateien

Abhängigkeits- und Paketdateien sind Dateien, die Informationen zu den Abhängigkeiten und Paketen enthalten, die von Ihrer Anwendung verwendet werden. Verschiedene Build-Tools, wie z der Node Package Manager (npm), erzeugen Sie diese Dateien.

Wenn Sie beispielsweise npm verwenden, um Abhängigkeiten für ein JavaScript-Projekt zu verwalten, wird ein "node_modules"-Ordner im Stammverzeichnis Ihres Projekts. Das Verzeichnis enthält alle installierten Abhängigkeiten für Ihr Projekt.

Dieses Verzeichnis kann sehr groß werden, insbesondere wenn Ihr Projekt viele Abhängigkeiten hat oder einige Abhängigkeiten große Dateigrößen haben. Durch den Ausschluss von „node_modules"-Ordner aus Ihrem Git-Repository, können Sie ihn sauber halten und seine Größe reduzieren.

Um das Hinzufügen des "node_modules" Verzeichnis zu Ihrem Git-Repository hinzufügen, fügen Sie seinen Namen zu Ihrer .gitignore-Datei hinzu:

#.gitignorieren
node_modules/

5. Betriebssystemdateien

Ihr Betriebssystem und andere Systemtools können bei normaler Verwendung Dateien generieren. Dazu können Protokolldateien, temporäre Dateien und Systemkonfigurationsdateien gehören. Ein Beispiel ist die Daumen.db Datei unter Windows und ihrem macOS-Äquivalent, der .DS_Store Datei.

Es empfiehlt sich im Allgemeinen, Betriebssystemdateien aus Ihrem Git-Repository auszuschließen, da sie sind spezifisch für Ihre lokale Umgebung und können je nach Computer und Betriebssystem unterschiedlich sein Systeme.

GitHub hat .gitignore-Richtlinien für empfohlen Windows, Mac OS, Und Linux.

Die Bedeutung der Versionskontrolle

Die Verwendung der Versionskontrolle kann Ihren Arbeitsablauf erheblich verbessern und Fehler und Konflikte reduzieren, die bei der Arbeit an einer Codebasis auftreten können. Mit der Versionskontrolle können Sie Codeänderungen einfach nachverfolgen, überprüfen und nahtlos mit Teammitgliedern zusammenarbeiten.

Sie sollten jedoch immer bestimmte Dateien wie Konfigurationsdateien, IDE-Dateien und Betriebssystemdateien ausschließen. Dadurch wird die Größe Ihres Repositorys gering gehalten und sichergestellt, dass Sie keine vertraulichen Informationen preisgeben.