Git: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Vogty (Diskussion | Beiträge)
Frank (Diskussion | Beiträge)
Git Pro Book URL
 
(13 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
[[GIT|Git]] ist ein [[Versionsverwaltung|Versionsverwaltungssystem]]. Es wird verwendet um
{{TOCRight}}[[GIT|Git]] ist ein [[Versionsverwaltung|Versionsverwaltungssystem]]. Es wird verwendet um
* Änderungen am Projekt zu protokollieren und diese zu archivieren.
* Änderungen am Projekt zu protokollieren und diese zu archivieren.
* Ältere Versionen wiederherzustellen.
* Ältere Versionen wiederherzustellen.
* Gemeinsames Arbeiten auf der selben Datenbasis zu ermöglichen.
* Gemeinsames Arbeiten auf der selben Datenbasis zu ermöglichen.


Wir verwenden Git im Sopra um genau diese Punkte zu ermöglichen. Jede Gruppe erhält ihr eigenes [[#Repository|Repository]] auf [[Gitea]] (einer Plattform ähnlich zu [https://de.wikipedia.org/wiki/GitHub GitHub]), um ihr Projekt zu verwalten.  
Wir verwenden Git im Softwarepraktikum um genau diese Punkte zu ermöglichen. Jede Gruppe erhält ihr eigenes [[#Repository|Repository]] auf [[Gitea]] (einer Plattform ähnlich zu [https://de.wikipedia.org/wiki/GitHub GitHub]), um ihr Projekt zu verwalten.  


__TOC__
__TOC__
Zeile 55: Zeile 55:


=== Remote ===
=== Remote ===
Remote ist die Bezeichnung für ein Repository, das zur Synchronisierung verwendet wird. Meistens ist dies auf einem externen Server und benötigt eine Authentifizierungsmethode um von diesem Änderungen zu holen (fetch) oder Änderungen hochzuladen (push). Im SOPRA verwendet jede Gruppe dazu ein eigenes auf [[Gitea|SOPRA Gitea]] gehostetes Repository.
Remote ist die Bezeichnung für ein Repository, das zur Synchronisierung verwendet wird. Meistens ist dies auf einem externen Server und benötigt eine Authentifizierungsmethode um von diesem Änderungen zu holen (fetch) oder Änderungen hochzuladen (push). Im Softwarepraktikum verwendet jede Gruppe dazu ein eigenes von uns mit [[Gitea]] gehostetes Repository.


=== HEAD ===
=== HEAD ===
Zeile 81: Zeile 81:
  git config --global user.name "Jane Doe"
  git config --global user.name "Jane Doe"


'''Hinweis''': Seiten wie GitHub oder auch das SoPra [[Gitea]] verwenden die Emailadresse um den Commit einem Benutzer zuzuordnen, die eingestellten Emailadressen sollten also übereinstimmen.
'''Hinweis''': Seiten wie GitHub oder auch unsere [[Gitea]] Instanz verwenden die Emailadresse um den Commit einem Benutzer zuzuordnen, die eingestellten Emailadressen sollten also übereinstimmen.


== Repository erstellen ==
== Repository erstellen ==
Zeile 93: Zeile 93:


== Repository klonen ==
== Repository klonen ==
Um ein bestehendes Repository in einen Ordner zu klonen benutzt man den clone Befehl:
[[Datei:gitea_repoUrl.png|right|thumb|500px|In der Repositoryansicht von Gitea sieht man die genauen URLs für das eigene Gruppenrepository in der roten Box.]]
Um ein bestehendes Repository in einen Ordner zu klonen benutzt man den <code>clone</code> Befehl. Dabei kann entweder HTTPS oder SSH als Protokoll verwendet werden. Beachten Sie dazu auch die Anleitungen zum [[Gitea#SSH Key hinzufügen|Hinzufügen eines SSH Keys zu Gitea]] und [[Gitea#HTTPS Kennwort einrichten|Setzen eines HTTPS Kennworts für Gitea]].


git clone https://sopragit.informatik.uni-freiburg.de/<semester>/<gruppe>.git
Für HTTPS verwendet man folgenden Aufruf:


Bzw. für die Authentifizierung mit SSH ist der äquivalente Befehl
git clone https://git.sopranium.de/<semester>/<gruppe>.git
 
Für SSH ist der äquivalente Befehl
   
   
  git clone gitea@sopragit.informatik.uni-freiburg.de:<gruppe>/<gruppe>.git
  git clone gitea@git.sopranium.de:<gruppe>/<gruppe>.git


Der Befehl <code>clone</code> legt eine exakte Kopie der gesamten Repositorydaten auf der lokalen Maschine ab.
Der Befehl <code>clone</code> legt eine exakte Kopie der gesamten Repositorydaten auf der lokalen Maschine ab.
Zeile 105: Zeile 108:
== Am Repository arbeiten ==
== Am Repository arbeiten ==


Im Folgenden zeigen wir die grundlegenden Handgriffe, die zur Benutzung von Git notwendig sind. Um tiefer in die Materie einzutauchen empfehlen wir [https://git-scm.com/book/de/v2/Los-geht%E2%80%99s-%C3%84nderungen-nachverfolgen-und-im-Repository-speichern Git Pro Book].
Im Folgenden zeigen wir die grundlegenden Handgriffe, die zur Benutzung von Git notwendig sind. Um tiefer in die Materie einzutauchen empfehlen wir [https://git-scm.com/book/de/v2 Git Pro Book].


==== Neue Datei ====
==== Neue Datei ====
Zeile 189: Zeile 192:
<tr><th><tt>bin</tt></th><td>Die Dateien in diesem Ordner werden automatisch beim [[Compiler|Kompillieren]] erstellt, sie hochzuladen ist also unnötig. Zudem sind auch binäre Dateien dabei die sich beim kompilieren häufig ändern. Da binäre Dateien nicht gemerged werden können wird das zu häufigen Konflikten mit den Commits anderer Teammitglieder führen.</td></tr>
<tr><th><tt>bin</tt></th><td>Die Dateien in diesem Ordner werden automatisch beim [[Compiler|Kompillieren]] erstellt, sie hochzuladen ist also unnötig. Zudem sind auch binäre Dateien dabei die sich beim kompilieren häufig ändern. Da binäre Dateien nicht gemerged werden können wird das zu häufigen Konflikten mit den Commits anderer Teammitglieder führen.</td></tr>
<tr><th><tt>obj</tt></th><td>Siehe <tt>bin</tt>.</td></tr>
<tr><th><tt>obj</tt></th><td>Siehe <tt>bin</tt>.</td></tr>
<tr><th><tt>_ReSharper.#PROJEKTNAME#</tt></th><td>Dieses Verzeichnis wird vom Resharper automatisch generiert. Automatisch generierte Ordner sollen nicht ins Git, siehe <tt>bin</tt>.</td></tr>
<tr><th><tt>*.suo</tt></th><td>Die Dateien mit der Endung .suo (''Solution User Options'') beinhalten eine Reihe von Benutzer-spezifischen Einstellungen für [[VisualStudioTutorial|Visual Studio]], die niemanden außer den Benutzer selber interessieren. Sie enthalten außerdem eine Reihe von absoluten Pfadangaben, die bei anderen Benutzern massive Probleme auslösen können. Sie sollen auf keinen Fall zum [[#Repository|Repository]] [[#Working Copy commiten|hinzugefügt]] werden.</td></tr>
<tr><th><tt>*.suo</tt></th><td>Die Dateien mit der Endung .suo (''Solution User Options'') beinhalten eine Reihe von Benutzer-spezifischen Einstellungen für [[VisualStudioTutorial|Visual Studio]], die niemanden außer den Benutzer selber interessieren. Sie enthalten außerdem eine Reihe von absoluten Pfadangaben, die bei anderen Benutzern massive Probleme auslösen können. Sie sollen auf keinen Fall zum [[#Repository|Repository]] [[#Working Copy commiten|hinzugefügt]] werden.</td></tr>
<tr><th><tt>*.cachefile</tt></th><td>Siehe <tt>bin</tt>. Auch merkt sich [[MonoGame]] hier, welche Dateien es schon in ein ihm genehmes Format konvertiert hat. Wenn ein anderes Teammitglied eine neue Datei hinzufügt und diese Datei im <tt>.cachefile</tt> als bereits konvertiert markiert ist, kann es passieren daß sich XNA denkt "Hey die Datei hab ich doch schon" und sie nicht neu konvertiert.</td></tr>
<tr><th><tt>*.cachefile</tt></th><td>Siehe <tt>bin</tt>. Auch merkt sich [[MonoGame]] hier, welche Dateien es schon in ein ihm genehmes Format konvertiert hat. Wenn ein anderes Teammitglied eine neue Datei hinzufügt und diese Datei im <tt>.cachefile</tt> als bereits konvertiert markiert ist, kann es passieren daß sich XNA denkt "Hey die Datei hab ich doch schon" und sie nicht neu konvertiert.</td></tr>
<tr><th><tt>*.DotSettings.user</tt></th><td>Diese Datei enthält Benutzerspezifische Resharper Einstellungen und soll entsprechend auch nicht eingecheckt werden.</td></tr>
<tr><th><tt>*.thumb</tt></th><td>Von Windows generierte Datei, die Vorschaubilder für die Miniaturansicht im Explorer enthält.</td></tr>
<tr><th><tt>*.thumb</tt></th><td>Von Windows generierte Datei, die Vorschaubilder für die Miniaturansicht im Explorer enthält.</td></tr>
<tr><th><tt>thumbs.db</tt></th><td>Siehe .thumb</td></tr>
<tr><th><tt>thumbs.db</tt></th><td>Siehe .thumb</td></tr>
Zeile 199: Zeile 200:


=== Mit mehreren Branches arbeiten ===
=== Mit mehreren Branches arbeiten ===
Im SOPRA verwenden wir hauptsächlich 2 Branches (siehe [[GitWorkflow| Git Workflow im Sopra]]).  
Im Softwarepraktikum verwenden wir hauptsächlich 2 Branches (siehe [[GitWorkflow| Git Workflow im Softwarepraktikum]]).  
* '''release''' => Hier ist der aktuelle Stand des Projekts in lauffähigem Zustand mit fertig implementierten Tasks. Dieser Branch ist Grundlage für die Bewertung des Spiels und Abgabe von Artefakten. Dieser Branch muss zu jeder Zeit ein kompillier- und lauffähiges Spiel darstellen.
* '''release''' => Hier ist der aktuelle Stand des Projekts in lauffähigem Zustand mit fertig implementierten Tasks. Dieser Branch ist Grundlage für die Bewertung des Spiels und Abgabe von Artefakten. Dieser Branch muss zu jeder Zeit ein kompillier- und lauffähiges Spiel darstellen.
* '''master''' => Hier werden die Tasks entwickelt. Sie müssen nicht zwangsläufig fertig sein, aber der master Branch soll zu jeder Zeit kompillieren und laufen.
* '''master''' => Hier werden die Tasks entwickelt. Sie müssen nicht zwangsläufig fertig sein, aber der master Branch soll zu jeder Zeit kompillieren und laufen.
Zeile 266: Zeile 267:
Hat man die Konflikte in dem Tool behoben, fügt Git die Dateien automatisch zur Stage hinzu, so dass man nur noch den merge Commit machen muss.
Hat man die Konflikte in dem Tool behoben, fügt Git die Dateien automatisch zur Stage hinzu, so dass man nur noch den merge Commit machen muss.


= Git Installieren =
= Git im Softwarepraktikum =
Es gibt unzählige Git Clients. Empfehlenswert ist vor allem für den Einstieg [https://git-scm.com/downloads Der offizielle Git client]. Wer gerne ein graphisches Interface hat, kann [https://tortoisegit.org/ tortoisegit] oder eine der [https://git-scm.com/downloads/guis zahlreichen Alternativen] verwenden.
== Git für das Softwarepraktikum vorbereiten ==
== Git für das SOPRA vorbereiten ==
Nachdem Sie sich für einen Git-Client entschieden haben, müssen Sie sicherstellen:
Nachdem Sie sich für einen Git-Client entschieden haben, müssen Sie sicherstellen:
* Dass ihr [[Gitea|Zugang zu Gitea]] funktioniert.
* Dass ihr [[Gitea|Zugang zu Gitea]] funktioniert.
* Das Repository Ihrer Gruppe auf ihren [[#Repository clonen|Rechner klonen]].
* Das Repository Ihrer Gruppe auf ihren [[#Repository klonen|Rechner klonen]].
* Ihren [[#Name und Email einstellen|Namen und die Email]] Adresse Git mitteilen.
* Ihren [[#Name und Email einstellen|Namen und die Email]] Adresse Git mitteilen.
* Stellen Sie sicher, dass eine <code>.gitignore</code> Datei mit den Regeln in der unter [[#Dateien Ignorieren|Dateien Ignorieren]] gegebenen Tabelle in ihrem Gruppenrepository im master Branch existiert.
* Stellen Sie sicher, dass eine <code>.gitignore</code> Datei mit den Regeln in der unter [[#Dateien Ignorieren|Dateien Ignorieren]] gegebenen Tabelle in ihrem Gruppenrepository im master Branch existiert.


== Git und Gitea ==
== Git und Gitea ==
Abgerufen von „https://sopranium.de/Git