Git Basics
Dieses Git Repository soll ein Überblick für die grundlegenden Git-Befehle bieten. Weitere Informationen zu den verwendeten Befehle sowie zu weiteren Git-Befehlen gibt es [hier]
Verwendete Befehle
Eine Tabelle zur Übersicht der verwendeten Befehle
Befehl | Info |
---|---|
git init |
Erstellung eines neuen Git Repository |
git add |
Dokumente/Verzeichnisse zum Staging-Bereich hinzufügen |
git restore --staged |
Dokumente/Verzeichnisse aus dem Staging-Bereich entfernen |
git status |
Überblick über die Unterschiede zum letzten Commit |
git commit |
Anlegen einer neuen Projektversion mit Dokumenten/Verzeichnissen aus dem Staging-Bereich |
git branch |
Überblick über alle Branches (-r für remote Branches, -a für remote und lokale Branches)
|
git branch <BRANCH> [<BRANCH/COMMIT>] |
Erstellen einer neuen Branch |
git branch -d |
Löschen einer lokalen Branch |
git checkout |
Zu einer anderen Branch wechseln |
git merge |
Zusammenführen von zwei Branches mit einem Merge-Commit |
git rebase |
Zusammenführen von zwei Branches durch anhängen der Commits |
git clone |
Remote Repository lokal kopieren |
git pull |
Lokales Repository mit Änderungen des remote Repository aktualisieren |
git push |
Remote Repository mit Änderungen des lokalen Repository aktualisieren |
Projekterstellung
Um Git zu benutzen muss erst ein Git Repository initialisiert (erstellt) werden.
Zur Erstellung eines lokalen Git Repositories wird der folgende Befehl verwendet: git init
- Falls kein Git Repository existiert, wird ein neues Repository lokal angelegt.
- Falls bereits ein Git Repository existiert, wird das Repository neu initialisiert, dabei werden keine Daten überschrieben
Zum anlegen von Git Repositories wird standardmäßig das aktuelle Verzeichnis genutzt. Um in einen bestimmten Verzeichnis ein Git Repository anzulegen kann der Pfad als weiterer Parameter angegeben werden.
Beispiel: Als Beispiel gibt es die folgende Verzeichnisstruktur, wobei das aktuelle Verzeichnis mit einem * markiert ist:
Verzeichnisstruktur | Git Befehl - Erstellung eines Repositories |
---|---|
|
|
Änderungen speichern
Das Hinzufügen von Dateien/Verzeichnissen erfolgt in zwei Schritten.
- Dokumente/Verzeichnisse zum Staging-Bereich (staging area) hinzufügen
- Dokumente/Verzeichnisse des Staging-Bereichs als neue Version speichern (Commit als neue Projektversion)
Staging-Bereich
Der Staging-Bereich dient als Sammlung von Dokumenten/Verzeichnissen deren Veränderungen gespeichert werden sollen.
Dokumente/Verzeichnisse befinden sich nicht automatisch im Staging-Bereich. Es müssen also alle Dokumente/Verzeichnisse explizit zum Staging-Bereich hinzugefügt werden.
Dokumtente/Verzeichnisse können mit git add <file/directory>
oder git stage <file/directory>
zum Staging-Bereich hinzugefügt werden.
Mit git add .
werden alle Dokumente/Verzeichnisse im aktuellen Verzeichniss zum Staging-Bereich hinzugefügt.
Dokumente/Verzeichnisse können mit git restore --staged <file/directory>
wieder aus dem Staging-Bereich entfernt werden.
Um sich eine Übersicht zum Stand des Repository (der aktuellen Branch) zu verschaffen kann der Befehl git status
genutzt werden.
Der Befehl vergleicht dafür den aktuellen Stand mit dem Stand des letzten Commits.
Dabei werden folgende Informationen berücksichtigt:
- Veränderte/bearbeitete Dokumente/Verzeichnisse
- Dokumente/Verzeichnisse in dem Staging-Bereich
- Informationen zur aktuellen Branch
Beispiel:
- In dem Beispiel wurden bereits Dokumente/Verzeichnisse zum Staging-Bereich hinzugefügt
- Dokumente/Verzeichnisse die sich im Staging-Bereich befinden sind mit einem (+) markiert
Dokumente/Verzeichnisse | Git Befehl - Staging von Dokumenten/Verzeichnissen | ||||||
---|---|---|---|---|---|---|---|
|
|
Dokumente/Verzeichnisse | Git Befehl - Unstaging von Dokumenten/Verzeichnissen | ||||||
---|---|---|---|---|---|---|---|
|
|
Dokumente/Verzeichnisse | Git Befehl - (Status) Unterschiede zum letzten Commit | ||
---|---|---|---|
|
|
Projektversion anlegen
Eine neue Projektversion wird mithilfe der Dokumente/Verzeichnisse, die sich im Staging-Bereich befinden, erstellt. Dokumente/Verzeichnisse die sich nicht im Staging-Bereich befinden werden nicht für die neue Projektversion verwendet.
Eine neue Projektversion wird nur im lokalen Repository erstellt!
Eine Projektversion wird in Git: Commit genannt und kann mit git commit -m "commit message"
erstellt werden.
Mit dem Parameter -m
kann ein Text für den aktuellen Commit (die neue Projektversion) gespeichert werden.
Dokumente/Verzeichnisse die mit einem Commit als neue Projektversion gespeichert werden, werden automatisch wieder aus dem Staging-Bereich entfernt.
Beispiel:
- In dem Beispiel wurden bereits Dokumente/Verzeichnisse zum Staging-Bereich hinzugefügt.
- Dokumente/Verzeichnisse die sich im Staging-Bereich befinden sind mit einem (+) markiert
Dokumente/Verzeichnisse | Git Befehl - Erstellen eines Commits (neue Projektversion erstellen) | ||
---|---|---|---|
|
|
Branching
In Git gibt es Branches. Eine Branch ist ein Verweis (Pointer) auf einen bestimmten Commit.
Commits und Branches | Info |
---|---|
|
|
Änderungen die auf einer Branch mit einem Commit gespeichert werden, sind nur auf dieser Branch (als Commit) vorhanden.
Jede Branch kann eigene Commits mit unterschiedliche Dokumente/Verzeichnisse speichern.
Diese Unterschiede werden als Verzweigungen der Commits sichtbar. (git log --graph --oneline --all
)
Commits und Branches | Info |
---|---|
|
|
Häufig gibt es eine Hauptbranch (main/master) von der andere Branches abzweigen.
Branch Operationen
Um Operationen mit Branches durchzuführen ist es sinnvoll einen Überblick zu allen existierenden Branches zu bekommen.
Die lokalen Branches können mit dem Befehl git branch
angezeigt werden.
Mit den Optionen -r
werden die remote Branches und mit -a
lokal und remote Branches angezeigt.
Zum anzeigen der Branches kann zusätzlich die --list
Option gesetzt werden, um mit einem Muster zu filtern.
Die aktuelle lokale Branch wird mit einem * markiert.
Zum erstellen einer neuen Branch kann git branch <BRANCH_NAME> [<COMMIT/BRANCH>]
verwendet werden.
Mit dem Parameter ([<COMMIT/BRANCH>]
) kann ein Commit oder eine Branch als Grundlage für die zu erstellende Branch angegeben werden.
Ohne diesen zusätzlichen Parameter ist die Grundlage der letzte Commit der aktuellen Branch.
Mit git checkout -b <NEUE_BRANCH> [<COMMIT/BRANCH>]
wird zusätzlich zu der neu erstellten Branch gewechselt.
Zum entfernen einer Branch kann git branch -d <BRANCH_NAME>
verwendet werden.
Zum wechseln zu einer anderen Branch kann git checkout <BRANCH_NAME>
verwendet werden.
Anstatt eine Branch anzugeben kann auch ein Commit durch den Commit-Hash oder einen relativen Pfad angegeben werden!
Ein relativer Pfad verweist auf einen Commit zuvor, von dem der aktuelle Commit abhängt.
Ein relativer Pfad kann von einem Commit (Commit-Hash~1
), einer Branch (Branch~1
) oder dem HEAD (HEAD~1
) angegeben werden.
Beispiel:
- Commits werden mit c markiert
- Aktuelle Branch wird mit einem (*) markiert
Commits und Branches | Git Befehl - Erstellung einer Branch | ||||||
---|---|---|---|---|---|---|---|
|
|
Commits und Branches | Git Befehl - Löschen einer Branch | ||
---|---|---|---|
|
|
Commits und Branches | Git Befehl - Wechseln zu anderen Commits/Branches | ||||
---|---|---|---|---|---|
|
|
Merging
In einem Git Repository kann es verschiedene Branches mit unterschiedlichen Dokumenten/Verzeichnissen geben. Um einen eindeutigen Projektstand wiederherzustellen, können Branches zusammengefügt werden. Häufig werden Branches wieder mit einer Hauptbranch zusammengefügt, die dann wieder als Ausgangspunkt für neue Branches dient.
Das Zusammenfügen von zwei Branches kann mit git merge
oder git rebase
erfolgen.
Merge:
Mit git merge
entsteht ein neuer Commit auf der aktuellen Branch.
Der Merge-Commit beinhaltet beide Branches als Vorgänger.
Rebase:
Mit git rebase
werden die Commits einer Branch ans ende der aktuellen Branch "geschoben".
Dabei wird der Abzweig mit den Commits entfernt.
Commits und Branches | Git Befehl - Mergen einer Branch | ||||
---|---|---|---|---|---|
|
|
Commits und Branches | Git Befehl - Mergen einer Branch | ||||
---|---|---|---|---|---|
|
|
Remote Repositories
Git Repository können auch auf Servern (Online) gespeichert werden.
Da das Repository Online gespeichert wird, kann unabhängig vom benutztem Gerät auf dieses remote Repository zugegriffen werden.
Dabei können mehrere Entwickler an einem Projekt (Repository) zusammenarbeiten.
Es gibt verschiedene Sichtbarkeitsstufen die für remote Repository festgelegt werden können:
- Private (Benutzer müssen zum Projekt (Repository) hinzugefügt werden - einzelned/als Gruppe)
- Internal (Benutzer der gleichen Organisation)
- Public (Alle Benutzer - ohne Authentifizierung)
Zusammenhang von remote und lokalen Repositories
Um Projekte Online unabhängig vom aktuellen Gerät zu speichern oder mit anderen Entwicklern an einem Projekt zu arbeiten, ist die Erstellung eines remote Repository sinnvoll.
Die verschiedenen Plattformen auf denen Git Projekte gespeichert werden dienen dabei vorallem als globaler Speicher/Zugriffsort.
Änderungen werden meistens in Entwicklungsumgebungen auf dem lokalen Gerät erstellt, indem das Projekt lokal kopiert und im Anschluss das remote Repository aktualisiert wird.
Änderungen des remote Repository können auch über die Web-Anwendung erstellt werden
Schritte zum lokalen Bearbeiten eines remote Repository:
-
Kopieren oder Aktualisieren eines remote Repository
Falls das remote Repository bereits als lokales Repositoy existiert, ist es ausreichend das Repository zu aktualisieren. Ansonsten muss das remote Repository kopiert werden.
-
Kopieren des remote Repository
Durch das Kopieren entsteht ein lokales Repository mit dem aktuellen Stand des remote RepositoryEs gibt zwei Repository von dem Projekt:
- Ein remote Repository (Online)
- Ein lokales Repository (auf dem lokalen Gerät)
Mit dem folgenden Befehl kann ein remote Repositoy kopiert werden:
git clone <URL des remote Repository>
-
Aktualisieren des lokalen Repository
Änderungen vom remote Repository müssen explizit zum lokalen Repository hinzugefügt werdenMit dem folgendem Befehl kann ein lokales Repository aktualisiert werden:
git pull
-
-
Bearbeiten des Projekts
Änderungen des Projekts können am lokalen Repository durchCommits
vorgenommen werdenDie lokalen
Commits
sind nur im lokalen Repository verfügbar und müssen explizit zum remote Repository hinzugefügt werden! -
Remote Repository aktualisieren
Durch das aktualisieren des remote Repository mit dem lokalen Repository werden die lokalenCommits
zum remote Repository hinzugefügtMit dem folgenden Befehl können Änderungen vom lokalen zum remote Repository hinzugefügt werden:
git push origin <Branch des remote Repository>
Beispiel:
- Commits werden mit c markiert
Git Befehle - Bearbeiten eines Repository | Remote Repository (origin main) | Lokales Repository (main) |
---|---|---|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Nutzen eines remote Repository
Falls ein Projekt als remote Repository gespeichert oder öffentlich zugänglich gemacht werden soll können folgende Möglichkeiten auftreten:
- Ein lokales Verzeichnis (Projekt) soll in einem remote Repository gespeichert werden
- Ein lokales Git Repository soll in einem remote Repository gespeichert werden
Für die Nutzung eines remote Repository muss dieses Repository erst erstellt werden.
Ein remote Repository hat eigene Branches (mit
origin
bezeichnet).
Diese Upstream Branches können mit lokale Branches verknüpft werden.
Dabei haben lokale Branches maximal ein Upstream Branch zu welcher lokale Commits für das remote Repository gepusht werden.
Erstellen eines remote Repository
Es gibt unterschiedliche Plattformen die das Hosten von Git Repository anbieten:
- GitHub
- GitLab
- Bitbucket
Erstellung eines remote Repository mit GitLab
-
New Project
(rechts oben) -
Create blank project
(oder von einem Template:Create from template
) - Repository Einstellungen
- Projektnamen
- Sichtbarkeitslevel (Private, Internal oder Public)
- README Dokument
Create project
Lokales Projekt
In diesem Fall existiert bereits ein Projekt ohne Git Repository. Dieses Projekt soll jetzt mit einem remote Repository gespeichert werden.
Folgende Schritte sind notwendig:
- Erstellen eines remote Repository
Auf einer Plattform die Git Repository hosted - Speicherort des Repository
- Navigation in das Verzeichnis des lokalen Projekts
cd [lokales Projekt]
- Erstellen eines lokalen Git Repository
git init --initial-branch=main
Bei GitLab standardmäßig die Hauptbranch: main
- Verknüpfung zum erstellten remote Repository herstellen
git remote add origin [URL des erstellten remote Repository]
- Alle Dokumente/Verzeichnisse im Repository speichern
git add . git commit -m "Initial commit"
- Die lokale Branch mit der Upstream Branch verknüpfen und den lokalen Commit zum remote Repository hinzufügen
git push --set-upstream origin main
Verknüpfung der lokalen Branch
main
mit der Upstream Branch (remote Branch)main
Dadurch werden Commits automatisch von der lokalen Branchmain
auf die remote Branchmain
gepusht
Lokales Repository
In diesem Fall gibt es bereits ein lokales Git Repository auf dem Gerät, das jetzt mit dem zuvor erstellten remote Repository verknüpft werden soll.
Folgende Schritte sind notwendig:
- Erstellen eines remote Repository
Auf einer Plattform die Git Repository hosted - Speicherort des Repository
- Navigation in das Verzeichnis des lokalen Projekts
cd [lokales Projekt]
- Entferen der Verknüpfung zu einem möglichen remote Repository
git remote rename origin old-origin
- Verknüpfung zum erstellten remote Repository herstellen
git remote add origin [URL des erstellten remote Repository]
- Festlegen der Upstream branches
git push --set-upstream origin --all
Verknüpfung der lokalen Branch
main
mit der Upstream Branch (remote Branch)main
Dadurch werden Commits automatisch von der lokalen Branchmain
auf die remote Branchmain
gepusht - Festlegen der Upstream tags
git push --set-upstream origin --tags
SSH Authentifizierung
Anstatt für jeden Zugriff auf das remote Repository immer den jeweiligen Benutzer und das zugehörige Password einzugeben, kann ein SSH Key verwendet werden.
Dazu wird auf dem lokalen Gerät ein SSH Key erstellt. (Es werden zwei Keys erstellt: ein öffentlicher (public) und ein privater (private) Schlüssel)
Der öffentliche Schlüssel wird auf der Plattform für die remote Repository hinterlegt.
Folgende Schritte sind notwendig:
- Erstellen eines SSH Keys
ssh-keygen -t ed25519 -C "<E-Mail Adresse>" -f ~/.ssh/id_example
Es wird ein öffentlicher (public -
.pub
) und ein privater (private) Schlüssel erstellt.
Optionen:-
-t
zum angeben des verwendeten SSH Typen - SSH Typen für GitLab -
-C
zum hinzufügen eines Kommentars (zum Beispiel die genutzte E-Mail Adresse auf der Plattform) -
-f
zum festlegen des Speicherortes und Names des Keys (hierid_example
)
-
-
Privaten (private) SSH Key zum ssh-agent hinzufügen
- SSH-Agent starten
eval $(ssh-agent -s)
-
Privaten (private) SSH Key hinzufügen
ssh-add ~/.ssh/id_example
- SSH-Agent starten
- SSH-Client konfigurieren (bei mehreren SSH-Keys)
- Bearbeiten des
~/.ssh/config
Dokuments# Beispiel Konfiguration für GitLab HOST gitlab.com PreferredAuthentications publickey IdentityFile ~/.ssh/id_example
- Bearbeiten des
-
Öffentlichen (public) SSH Key zur Plattform hinzufügen
Schritte für GitLab:Edit profile
SSH Keys
Add new key
- Einfügen des öffentlichen (public) Key mit SSH Typen
Beispiel:ssh-ed25519 AA..
Add key
- Repository mit SSH clonen
Um den SSH Key zu verwenden, muss das Repository über SSH geclont werden.
Die aktuelle remote URL kann mit dem folgenden Befehl angezeigt werden:git remote -v