Wie man .gitignore verwendet: Eine praktische Einführung mit Beispielen

Syntax von .gitignore

Wie bereits erwähnt, enthalten .gitignore Dateien Muster, die mit den Dateinamen in deinem Repository abgeglichen werden, um festzustellen, ob sie ignoriert werden sollen oder nicht.

Grundlegende Syntax

Im Kern besteht die Datei .gitignore aus Zeilen, die jeweils ein zu ignorierendes Muster darstellen. Muster können übereinstimmen:

• Besondere Dateien
• Dateitypen
• Verzeichnisse 

Die Datei unterstützt auch Kommentare, die mit # eingefügt werden können, sowie Leerzeilen, um die Lesbarkeit zu verbessern.

Hier ist ein Überblick über die Grundstruktur:

• Eine bestimmte Datei ignorieren: Du kannst den Dateinamen direkt auflisten, um ihn zu ignorieren.

secrets.txt

• Ein ganzes Verzeichnis ignorieren: Indem du ein / am Ende des Verzeichnisnamens hinzufügst, kannst du alles innerhalb dieses Verzeichnisses ignorieren.

logs/

• Alle Dateien eines bestimmten Typs ignorieren: Wildcards (*) können verwendet werden, um alle Dateien mit einer bestimmten Erweiterung zu ignorieren.

*.py

• Negation: Du kannst ! verwenden, um ein Muster zu negieren und bestimmte Dateien oder Verzeichnisse explizit zu verfolgen, die sonst ignoriert werden würden.

*.txt  # Ignores all .txt files
!readme.txt  # Except for readme.txt

Wie man eine .gitignore-Datei erstellt und verwendet

Die Erstellung und Verwendung von .gitignore ist ziemlich einfach. In diesem Abschnitt gehe ich die einzelnen Schritte durch.

Erstellen einer .gitignore-Datei

Schritt 1: Navigiere zum Stammverzeichnis deines Repositorys. Die Datei .gitignore wird normalerweise im Stammverzeichnis eines Git-Projekts abgelegt. Öffne dein Terminal oder deine Kommandozeile und navigiere zum Stammverzeichnis deines Git-Repositorys:

cd /path/to/your/repo

Schritt 2: Erstelle die Datei .gitignore. Wenn du im Stammverzeichnis bist, erstelle die Datei .gitignore mit einem beliebigen Texteditor oder indem du einen Befehl im Terminal ausführst, wie zum Beispiel:

touch .gitignore

Schritt 3: Füge Muster in die Datei ein. Öffne die Datei .gitignore in einem Texteditor und füge die notwendigen Muster hinzu, um Dateien oder Verzeichnisse zu ignorieren. Jede Linie steht für ein anderes Muster.

Hier ist ein Beispiel für eine .gitignore Datei, die häufig in einem Basisprojekt verwendet wird:

# Ignore node_modules and dependency directories
node_modules/
vendor/

# Ignore build artifacts
dist/
build/
*.log

# Ignore system-generated files
.DS_Store
Thumbs.db

# Ignore environment and secret files
.env
config.json

Wenn du die notwendigen Muster hinzugefügt hast, speichere die Datei. Git ignoriert diese Dateien jetzt automatisch, wenn du Änderungen bereitstellst oder überträgst.

Schritt 4: Übertrage die Datei in das Repository. Es ist wichtig, die Datei .gitignore an das Repository zu übergeben, damit alle Mitarbeiter dieselben Ignorierregeln verwenden. So wird die Einheitlichkeit des Projekts für alle Beteiligten sichergestellt.

git add .gitignore
git commit -m "Add .gitignore file"
git push

Sobald die Datei .gitignore übertragen ist, legst du gemeinsame Ignorierregeln für das gesamte Team fest.

Du willst Pushing und Pulling in Git beherrschen? In diesem Git Push- und Pull-Tutorial erfährst du, wie du deine Arbeit mit entferntene Repositories synchronisieren kannst.

Best Practices für die Verwendung von .gitignore

Das Anlegen einer .gitignore Datei ist zwar ein einfacher Teil der Pflege eines sauberen Git-Repositorys, doch sollten einige Best Practices befolgt werden, um sicherzustellen, dass die Datei im Laufe der Zeit effektiv verwaltet wird.

Verwende eine globale .gitignore

Für Entwickler, die mit mehreren Projekten arbeiten, gibt es bestimmte Dateien, die du aus jedem Projektarchiv ausschließen möchtest, unabhängig vom Projekttyp.

Anstatt sie in die .gitignore Datei jedes Projekts einzufügen, kannst du eine globale .gitignore konfigurieren, die für alle Repositories auf deinem System gilt.

So konfigurierst du eine globale .gitignore Datei:

• Erstelle eine .gitignore_global Datei:

touch ~/.gitignore_global

• Füge Muster für Dateien hinzu, die du global ignorieren willst, wie z.B.:

.DS_Store
*.log
/.vscode/
/.idea/

• Stelle Git so ein, dass es die globale .gitignore verwendet:

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

Vorhandene Vorlagen nutzen

Anstatt für jedes neue Projekt eine .gitignore Datei von Grund auf neu zu erstellen, kannst du vorkonfigurierte .gitignore Vorlagen für bestimmte Sprachen, Frameworks oder Umgebungen nutzen.

Eine der besten Quellen für diese Vorlagenist das offizielle .gitignore-Repository von GitHub, wo du .gitignore Dateien findest, die auf Hunderte von Programmiersprachen und Frameworks zugeschnitten sind.

Überprüfe .gitignore regelmäßig

Wenn sich ein Projekt weiterentwickelt, müssen möglicherweise neue Dateien und Verzeichnisse in die Datei .gitignore aufgenommen werden. Es ist wichtig, dass du deine Datei regelmäßig überprüfst und aktualisierst, damit sie den aktuellen Stand deiner Projekte widerspiegelt.

Einige Szenarien, in denen du die Datei .gitignore aktualisieren musst, sind:

• Die Einführung neuer Werkzeuge oder Bibliotheken, die zusätzliche Dateien erzeugen (z. B. der Wechsel zu einem neuen Build-System).
• Wenn du Verzeichnisse umgestaltest oder neu organisierst, können neue Dateien entstehen, die ausgeschlossen werden sollten.
• Entfernen von veralteten Dateien oder Verzeichnissen, die nicht mehr Teil des Projekts sind.

Fehlersuche bei .gitignore

Auch wenn du eine .gitignore Datei eingerichtet hast, kann es vorkommen, dass bestimmte Dateien verfolgt werden oder dass Muster nicht wie erwartet funktionieren. In diesem Abschnitt geht es um zwei häufige Fehlerquellen und wie du sie beheben kannst.

Lernpfad für bereits übertragene Dateien 

Die Datei .gitignore gilt nicht rückwirkend für bereits übertragene Dateien. 

Wenn du einen Lernpfad zu .gitignore hinzufügst, nachdem bestimmte Dateien bereits committed wurden, verfolgt Git sie weiter, auch wenn sie mit dem Muster in der Datei .gitignore übereinstimmen.

Um das Verfolgen von Dateien, die bereits übertragen wurden, zu beenden, befolge diese Schritte:

• Entferne die Dateien aus dem Lernpfad von Git: Verwende den Befehl git rm, um sie aus dem Repository zu entfernen, sie aber in deinem Arbeitsverzeichnis zu behalten.

git rm --cached <file_or_directory_name>

• Bestätige die Änderungen: Nachdem du die Dateien aus dem Lernpfad von Git entfernt hast, musst du die Änderungen festschreiben, um sicherzustellen, dass die Dateien nicht mehr Teil der Versionskontrollhistorie sind.

git commit -m "Stop tracking ignored files"

• Pushe die Änderungen in das entfernte Repository: Zum Schluss schiebst du die Änderungen in das entfernte Repository, um sicherzustellen, dass die Dateien nicht mehr verfolgt werden.

git push

Nachdem du diese Schritte durchgeführt hast, hört Git auf, die Dateien zu verfolgen. Die übertragene Datei befindet sich weiterhin in deinem Arbeitsverzeichnis, wird aber bei zukünftigen Übertragungen auf der Grundlage deiner .gitignore Muster ignoriert.

Sicherstellen, dass die Muster funktionieren 

Manchmal stellst du fest, dass bestimmte Dateien, von denen du erwartet hast, dass sie ignoriert werden, immer noch im Git-Status auftauchen oder nachverfolgt werden. 

Befolge diese Schritte, um sicherzustellen, dass deine .gitignore Muster richtig funktionieren:

• Überprüfe den Status deiner Dateien: Mit dem Befehl git status kannst du sehen, welche Dateien von Git verfolgt werden. So kannst du überprüfen, ob deine ignorierten Dateien noch aufgelistet sind.

git status

• Achte darauf, dass das Muster korrekt ist: Überprüfe die Syntax deiner .gitignore Muster, um sicherzustellen, dass sie richtig formatiert sind. Zum Beispiel:
• Stelle sicher, dass du den richtigen Verzeichnispfad verwendest (relativ zum Stammverzeichnis des Repositorys).
• Füge eine / hinzu, um bestimmte Verzeichnisse anzusteuern, damit nicht alle Dateien mit ähnlichen Namen verfolgt werden.

• Aktualisiere den Cache: Wenn du deine .gitignore Datei kürzlich aktualisiert hast und die Änderungen nicht übernommen werden, hält Git möglicherweise an seinem vorherigen Cache fest. Um den Cache zu aktualisieren, führst du den folgenden Befehl aus:

git rm -r --cached .
git add .
git commit -m "Refresh .gitignore"

• Prüfe auf Ausnahmen: Manchmal kann ein bestimmtes Muster in .gitignore durch ein spezifischeres Muster an anderer Stelle in der Datei überschrieben werden. Überprüfe deine Regeln, um sicherzustellen, dass es keine widersprüchlichen Muster gibt.

Du suchst nach einer schnellen Git-Referenz? Mit diesem Git-Spickzettel hast du die wichtigsten Befehle immer griffbereitertips.

Fazit

Eine .gitignore Datei mag klein erscheinen, aber sie spielt eine große Rolle dabei, dein Git-Repository sauber und übersichtlich zu halten. Indem du unnötige Dateien - wie Abhängigkeiten, Build-Artefakte und vom System generierte Dateien - ignorierst, stellst du sicher, dass dein Projekt organisiert und frei von Unordnung bleibt.

In diesem Tutorial hast du gelernt, wie du eine .gitignore Datei erstellst, Muster hinzufügst und Best Practices anwendest, um dein Repo effizient zu halten. Mit diesen Fähigkeiten vermeidest du Kopfschmerzen bei der Versionskontrolle und erleichterst die Zusammenarbeit für alle in deinem Team.

Wenn du deine Git-Kenntnisse vertiefen möchtest, findest du in Git Fundamentals einen strukturierten Lernpfad. Du kannst auch praktische Kurse wie Foundations of Git und Introduction to GitHub Concepts besuchen, um dir ein solides Verständnis der Versionskontrolle und der Arbeitsabläufe der Zusammenarbeit anzueignen!