Gitea

Aus Das Sopra Wiki

Gitea ist ein leichtgewichtiger Git-Service. Es ist ähnlich zu GitHub, Bitbucket, und Gitlab. Gitea ist ein fork von Gogs. Im SoPra wird Gitea zum einen als remote-Repository verwendet zum anderen als Tool zum umsetzen von Scrum (Scrum und Gitea).

Startseite

 
Abbildung 1: Die Startseite von Gitea.

Auf der Startseite von Gitea (Abildung 1) befindet sich:

  • Eine Übersicht über die neuesten Commits und Aktivitäten in Repositories auf die man Zugriff hat (linke Spalte). In diesem Beispiel ausschließlich Repository sopra-ws18/sopra11
  • Eine Übersicht über alle Repositories auf die man Zugriff hat (rechte Spalte).

Drückt man auf einen der vielen Links mit sopra-ws18/sopra11, wechselt man auf die Übersichtsseite des Repositories.

Repository Übersicht

 
Abbildung 2: Die Repositoryansicht von Gitea.

Die Repositoryübersicht ist in mehrere Registerkarten unterteilt (Abbildung 2):

  • Code: bietet eine Übersicht über das Repository. Es zeigt die aktuelle Version des default Branch (hier dev).
  • Issues: zeigt alle Issues im Projekt an. Hier lassen sich auch Labels bearbeiten und Milestones erstellen.
  • Pull Requests: zeigt eine Liste von allen Pull Requests die im Repository gestellt wurden.
  • Releases: listet Releases auf, die im Projekt erstellt wurden. Releases verbinden einen bestimmten Zustand des Repositories mit einem Titel, einem Text und zusätzlich hochgeladenen Dateien (z.B: einer kompillierten Version des Programms).
  • Wiki: erlaubt es jedem Benutzer des Repositories Wiki-Seiten für das Projekt zu erstellen.


Weitere Funktionen

Repository

 
Abbildung 3: Die Repositoryansicht von Gitea. Die Rote Box markiert die URL des Repositories zum Klonen.

Das Repository kann über die unter Code angezeigte URL geklont werden (Siehe Abbildung 3 ). Es ist möglich auf Repository über HTTPS (über Username und Passwort des Giteaaccounts) oder per SSH (mit einem SSH-Key) zuzugreifen. Vor- und Nachteile der einzelnen Methoden können im GitBuch nachgelesen werden.

Pull Request

 
Abbildung 4: Erstellen eines Merge-Request in Gitea.
 
Abbildung 5: Zusammenführen eines pull request in Gitea.

Im Sopra wird das Spiel auf dem "master" branch entwickelt. Ist ein wöchentlicher Sprint abgeschlossen, müssen die Änderungen die während des Sprints gemacht wurden mit dem "release" branch zusammengeführt werden.

Workflowim Sopra

Pull request erstellen. Siehe auch Abbildung 4

  • Auf der Navigationsleiste des Repository in Gitea auf "Pull-Requests" klicken, oder den Link <link_zur_repo_übersicht>/pulls aufrufen.
  • Klick auf "Neuer Pull-Request", dann auswählen von "Ziel: release", "Pullen von: master".
  • Als Titel "Merge work done in sprint01" oder etwas ähnliches sinvolles eintragen.
  • Eventuell eine kleine Zusammenfassung der Änderungen in "Verfassen" hinzufügen.
  • Rechts unter "Meilenstein" den zugehörigen Sprint wählen.
  • Klick auf "Pull-Request erstellen".

Jetzt ist der Pull request in Gitea verfügbar. Als nächster Schritt kann man den Pull request zusammenführen. Siehe auch Abbildung 5

  • Auf der Navigationsleiste des Repository in Gitea auf "Pull-Requests" klicken, oder den Link <link_zur_repo_übersicht>/pulls aufrufen.
  • Pull-request der zusammengeführt werden soll anklicken.
  • Klicken auf "Pull-Request zusammenführen".
  • Im sich öffnenden Dialog im ersten Feld "Merge Branch ..." ersetzen durch "Merge work done in Sprint<XX>".
  • Klicken auf "Pull-Request zusammenführen". Dadurch werden die Commits aus dem Quell (master) in den Ziel (release) Branch durch einen Merge Commit hinzugefügt.

Fertig.

Exkurs über das mergen: In Gitea ist standardmäßig "Pull-Request zusammenführen" ausgewählt, die Variante die wir im Sopra verwenden. Es gibt aber auch die Optionen "Rebasen und Mergen" und "Zusammenfassen und Mergen".

Bei "Rebasen und Mergen" werden die Commits aus dem Quell (master) in den Ziel (release) Branch hinzugefügt, ohne einen Merge Commit. Allerdings unterscheidet sich Giteas "rebase" von "git rebase" und es werden neue aber identische Commits erzeugt, die dann andere Hashes haben. Dies würde Konflikte erzeugen wenn der master Branch weiter zum entwickeln genutzt wird, da beim nächsten merge request die eigentlich identischen Comitts als unterschiedlich angesehen werden. Man müsste also jedes mal "master" löschen und neu erstellen.

Bei "Zusammenfassen und Mergen" werden alle Commits der Quelle (master) in einen Commit gepackt und nur dieser an den Ziel Branch (release) angefügt. Es geht also die Granulierung gurch zusammenfassen aller Vorgänger Commits im Ziel Branch (release) verloren.

Siehe auch dieser Github Artikel für mehr Information, der das identische verhalten von Github beim Zusammenführen von Merge-Requests beschreibt.

SSH Key hinzufügen

Um dem Git Client Zugriff auf das Repository zu geben, kann man einen SSH-Key zu seinem Account hinzufügen. Dazu öffnet man https://sopragit.informatik.uni-freiburg.de/user/settings/keys und klickt auf SSH-Schlüssel verwalten. Jetzt kann man den öffentlichen Teil des Schlüssels eintragen und mit Klick auf Schlüssel hinzufügen dem Account hinzufügen.