Web-Entwickler Bootcamp / Bonusmodul: Git
0%
In Bearbeitung

Git – .gitignore erstellen

In Git wird der Begriff "ignorieren" verwendet, um absichtlich nicht getrackte Dateien anzugeben, die Git ignorieren soll. Es hat keinen Einfluss auf die Dateien, die bereits von Git getrackt wurden.

Manchmal möchtest du die Dateien nicht an einen Git-Dienst wie GitHub senden. Wir können Dateien in Git angeben, die ignoriert werden sollen.

Das Dateisystem von Git ist in drei Kategorien eingeteilt:

1. Verfolgt (Tracked):

Verfolgte Dateien sind solche Dateien, die zuvor gestaged oder committed wurden.

2. Nicht getracked (Untracked):

Nicht verfolgte Dateien sind solche Dateien, die noch nicht gestaged oder committed wurden.

3. Ignoriert (Ignored):

Ignorierte Dateien sind solche Dateien, die von git explizit ignoriert werden. Wir müssen git anweisen, welche Dateien ignoriert werden sollen.

Generell sind die Ignorierten Dateien Artefakte und maschinell erzeugte Dateien. Diese Dateien können aus dem Quellcode deines Repositorys stammen oder sollten anderweitig nicht committed werden. Einige häufig ignorierte Dateien sind wie folgt:

  • Dependency-Caches
  • kompilierter Code
  • Output-Verzeichnisse, wie /bin, /out oder /target
  • Log-Dateien, wie .log, .lock oder .tmp
  • Versteckte Systemdateien, wie Thumbs.db oder.DS_Store
  • Persönliche IDE-Konfigurationsdateien, wie zum Beispiel .idea/workspace.xml

Von Git ignoriere Dateien

.gitignore ist eine Datei, die eine beliebige Datei oder ein Ordner sein kann, der alle Dateien enthält, die wir ignorieren wollen. Entwickler ignorieren Dateien, die nicht notwendig sind, um das Projekt auszuführen.

Git selbst erstellt viele vom System generierte ignorierte Dateien. Normalerweise sind das versteckte Dateien. Es gibt verschiedene Möglichkeiten, die Ignorier-Dateien anzugeben. Die ignorierten Dateien können in einer .gitignore-Datei verfolgt werden, die sich im Hauptverzeichnis des Repositorys befindet. Es wird kein expliziter Befehl verwendet, um die Datei zu ignorieren.

Es gibt keinen expliziten git-Ignorier-Befehl; stattdessen muss die .gitignore-Datei von Hand editiert und committed werden, wenn du neue Dateien hast, die du ignorieren möchtest. Die .gitignore-Dateien enthalten Muster, die mit den Dateinamen in deinem Repository abgeglichen werden, um zu bestimmen, ob sie ignoriert werden sollen oder nicht.

Wie man Dateien manuell ignoriert

Es gibt keinen Befehl in Git, um Dateien zu ignorieren; alternativ gibt es mehrere Möglichkeiten, die Dateien in Git zu ignorieren. Einer der gebräuchlichsten Wege ist die .gitignore-Datei. Lass es uns mit einem Beispiel verstehen.

.gitignore-Datei:

Regeln für das Ignorieren von Dateien werden in der .gitignore-Datei definiert. Die .gitignore-Datei ist eine Datei, die alle Formate und Dateien der ignorierten Datei enthält. Wir können mehrere Ignore-Dateien in einem anderen Verzeichnis erstellen.

So geht das in der Praxis:

Schritt 1: Erstelle eine Datei namens .gitignore, falls du sie noch nicht in deinem Verzeichnis hast. Um eine Datei zu erstellen, benutze den Befehl touch oder cat in Git Bash.

So geht's:

touch .gitignore

Alternativer Befehl zum Erstellen der .gitignore:

cat .gitignore

Der obige Befehl wird eine .gitignore-Datei in deinem Verzeichnis erstellen. Denke daran, dass du an deinem gewünschten Verzeichnis arbeitest. Beachte den unten stehenden Befehl:

Der obige Befehl wird eine Datei namens .gitignored erstellen. Wir können sie im Repository verfolgen. Betrachte das untere Bild:

Wie du auf dem obigen Bild siehst, wurde eine .gitignore-Datei für mein Repository erstellt.

Schritt 2: Jetzt fügst du die Dateien und Verzeichnisse zu der .gitignore-Datei hinzu, die du ignorieren möchtest.

Um die Dateien und Verzeichnisse zu der .git ignore Datei hinzuzufügen, öffne die Datei und gib den Dateinamen, den Verzeichnisnamen an, die ignoriert werden sollen:

Zur Verdeutlichung hier ein Screenshot meines Texteditors der geöffneten .gitignore-Datei:

In meiner Datei habe ich eine .html-Datei, ein Verzeichnis und eine Wildcard zum Ignorieren angegeben. Die Wildcard *.txt ignoriert alle Textdateien aus dem Repository, und /todo-liste/* ignoriert den neuen Ordner und seinen Unterinhalt. Zusätzlich ignoriere ich die die Einzeldatei "landing-page.html".

Schritt 3: Damit die Datei wirksam wird, müssen wir sie noch speichern, dem Staging-Bereich hinzufügen und dann comitten. Diese Vorgänge kennst du ja bereits.

Führe dafür diese Befehle durch:

git add .gitignore
git commit -m "Ignoriertes Verzeichnis erstellt"

Das war es schon!

Regeln für das Einfügen des Musters in die .gitignore-Datei:

Die Regeln für die Muster, die in die .gitignore-Datei eingefügt werden können, sind wie folgt:

  • Git ignoriert die leeren Zeilen oder Zeilen, die mit # beginnen.
  • Die Muster können mit einem Schrägstrich (/) vorwärts gestartet werden, um rekursiv zu vermeiden.
  • Die Muster können mit einem Schrägstrich (/) beendet werden, um ein Verzeichnis anzugeben.
  • Die Muster können verneint werden, indem man sie mit einem Ausrufezeichen (!) beginnt.

Wie liste ich die ignorierten Dateien auf?

In Git, können wir die ignorierten Dateien auflisten. Es gibt verschiedene Befehle, um die ignorierten Dateien aufzulisten, aber der gebräuchlichste Weg, die Datei aufzulisten, ist der Befehl ls. Um die ignorierten Dateien aufzulisten, führe den ls-Befehl wie folgt aus:

git ls-files -i --exclude-standard

Oder alternativ:

git ls-files --ignore --exclude-standard

Der obige Befehl listet alle verfügbaren ignorierten Dateien aus dem Repository auf. In dem angegebenen Befehl steht -I Option für ignorieren und --exclude-standard ist die Angabe des Ausschlussmusters.

hallowelt.txt
landing-page.html
website1.txt

Hier der Screenshot aus Git Bash:

Aus der obigen Ausgabe können wir sehen, dass der Befehl ls die verfügbaren ignorierten Dateien aus dem Repository auflistet.

Zusammenfassung

Du hast in dieser letzten Lektion gelernt, wie du mithilfe der .gitignore Datei Dateien und ganze Verzeichnisse in deinen Repositorys ignorieren kannst. Das ist besonders für versteckte Dateien sowie automatisch erzeugte Dateien (z.B. Log- oder Caching-Dateien) hilfreich, um deine Repositories sauber und übersichtlich zu halten.

Weiterhin darf ich dir Gratulieren. Du hast soeben das Ende des Git Schnellstart erreicht 🙂

Reife Leistung! Ich hoffe, dass du viel gelernt hast. Du kannst diesen Kurs jederzeit als Referenz nehmen, wenn du bei einem der Themen noch unsicher bist oder die Git-Befehle nicht auswendig kennst.