Skip to Content

Wiki source code of GitLab Erklärungen

Version 105.1 by pmeyer on 2025/09/11 15:40
Show last authors
1 [[image:Main.Organisatorisches.WebHome@softwareprojekt_logo_transparent.png||alt="SoftwareprojektLogo.png" data-xwiki-image-style-alignment="end" height="136" width="309"]]
2
3 {{toc/}}
4
5 Ab dem Wintersemester 2025/2026 wird die Projektstrukturierung und der [[Scrum>>doc:Main.Scrum.WebHome]]-Prozess in GitLab durchgeführt. Für die wichtigsten, grundlegendsten Funktion gibt es nachfolgend als Einstiegshilfe einige Erklärungen.
6
7 = Issue/Task-Erstellung in GitLab =
8
9 Für die Erstellung von Issues (User-Stories) oder Tasks (Aufgaben) wird in der Projektnavigationsleiste der Reiter** "Issues" **angeklickt und nachfolgend die Option **"New issue"** ausgewählt.
10
11 [[image:Issue1.png||data-xwiki-image-style-border="true"]]
12
13 Anschließend öffnet sich ein neues Fenster mit vielen Option. Hierbei kann ein Typ, ein Titel, eine Beschreibung und viele weitere unterschiedlichen Funktionen festgelegt werden.
14
15 Als **"Type" **stehen drei Optionen zur Auswahl:
16
17 * "Incident" - Ein Zwischenfall/Störung
18 * "Issue" - Im SWP eine User-Story (siehe [[User-Stories>>doc:Main.Scrum.WebHome||anchor="HUserStories"]])
19 * "Task" - Eine Aufgabe
20
21 Im unten gezeigtem Beispiel wird ein Issue gewählt und mit einem Titel (Name der User-Story) und einer Beschreibung (Akzeptanzkriterien) versehen.
22
23 Zusätzlich ist es möglich den Status (bspw. "To do", "Done", "In progress" etc), den Bearbeiter (ein oder mehrere Gruppenmitglieder), ein oder mehrere Labels, einen Meilenstein (siehe: ), Schätzungen und viele weitere Funktionen einzustellen. Anschließend werden die Angaben mit dem **"Create issue"** Button bestätigt.
24
25 [[image:Issue2.png||data-xwiki-image-style-border="true"]]
26
27 Es besteht im Anschluss direkt die Option sogenannte **"Child items"** hinzuzufügen. Dies ist besonders sinnvoll wenn die User-Story relativ umfangreich ist und somit besser in kleinere Arbeitspakete (bzw. Aufgaben) zerteilt werden sollte. Hierfür wird der **"Add"**-Button und entweder **"New task"** oder **"Existing task"** ausgewählt. Somit können entweder neue Aufgaben formuliert (wie im kommenden Beispiel) oder bestehende hinzugefügt werden.
28
29 [[image:Issue3.png||data-xwiki-image-style-border="true"]]
30
31 Hier wurde als Aufgabe das Feld für die Eingabe definiert. Anschließend wurde die Eingabe mit **"Create task"** bestätigt.
32
33 [[image:Issue4.png||data-xwiki-image-style-border="true"]]
34
35 Nachdem alle Informationen eingepflegt und ausführlich beschrieben wurden, ist das Issue vorerst fertig.
36
37 [[image:Issue5.png||data-xwiki-image-style-border="true"]]
38
39 == Status bei Issues ==
40
41 In GitLab werden standardmäßig fünf verschiedene Statusformen angeboten. Diese Optionen sind:
42
43 * **To do** (wird bei der Issue Erstellung standardmäßig ausgewählt)
44 * **In progress**
45 * **Done**
46 * **Won't do**
47 * **Duplicate**
48
49 Diese Statusformen werden genutzt um eine Sortierung und/oder Priorisierung der Issues zu ermöglichen. Zusätzlich dienen diese aber auch als Orientierung für das gesamte Projektteam. Somit weiß jedes Gruppenmitglied was erledigt ist und was noch erledigt werden muss.
50
51 [[image:Issue Status 1.png||data-xwiki-image-style-border="true"]]
52
53 Zur Status Änderung wird einfach die **"Edit"**-Option betätigt und anschließend öffnet sich ein Optionsmenü. Die gewünschte Option muss nur noch bestätigt werden und der neue Status wird festgelegt.
54
55 [[image:Issue Status 2.png||data-xwiki-image-style-border="true"]]
56
57 [[image:Issue Status 3.png||data-xwiki-image-style-border="true"]]
58
59 == Meilensteine und Epics ==
60
61 Im Laufe des Softwareprojektes werden eine Menge an Issues erstellt. Damit der Überblick, über die Vielzahl an Issues, nicht verloren geht wird im Softwareprojekt mit Meilensteinen (siehe [[Meilensteine>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:DievordefiniertenMeilensteine"]]) und Epics gearbeitet. In GitLab werden beide Funktionen mit **"Labels"** umgesetzt. Diese Option ist im Reiter "Manage" und anschließend unter "Labels" vorzufinden.
62
63 [[image:Label 1.png||data-xwiki-image-style-border="true"]]
64
65 [[image:Label 2.png||data-xwiki-image-style-border="true"]]
66
67 [[image:Label 3.png||data-xwiki-image-style-border="true"]]
68
69 Die Erstellung von Epics sind kongruent zur Erstellung der Meilensteine-Label**. **Zur Veranschaulichung wird das Epic-Label **"Lobby" **erstellt.
70
71 [[image:Epic1.png||data-xwiki-image-style-border="true"]]
72
73 [[image:Epic2.png||data-xwiki-image-style-border="true"]]
74
75 [[image:Epic3.png||data-xwiki-image-style-border="true"]]
76
77 Bei der Issue-Erstellung/Bearbeitung können die erstellten Labels jetzt mit den neuen/bestehenden Issues verknüpft werden. Dies erfolgt trivial zur Status-Option.
78
79 [[image:Issue Label 2.png||data-xwiki-image-style-border="true"]]
80
81 [[image:Label 4.png||data-xwiki-image-style-border="true"]]
82
83 [[image:Issue Label 3.png||data-xwiki-image-style-border="true"]]
84
85 ----
86
87 = Product-Backlog =
88
89 Die erstellten Issues werden automatisch nach der Erstellung dem Product-Backlog (siehe [[Product-Backlog>>doc:Main.Scrum.WebHome||anchor="HProductBacklog"]]) hinzugefügt. Der Product-Backlog ist eine Liste mit allen erstellten und unbearbeiteten Issues. Dieser ist im GitLab unter dem Reiter **"Issue boards" **vorzufinden.
90
91 [[image:ProductBacklog1.png||data-xwiki-image-style-border="true"]]
92
93 [[image:ProductBacklog2.png||data-xwiki-image-style-border="true"]]
94
95 == Pflege/Priorisierung des Product-Backlogs ==
96
97 Die Pflege des Product-Backlogs (siehe [[Pflege>>doc:Main.Scrum.WebHome||anchor="HDerNutzeneinesgepflegten2FpriorisiertenProductBacklogs"]]) ist in GitLab sehr einfach durchzuführen. Hierfür werden die Issues einfach per "Drag and Drop" (Ziehen und Ablegen) in die gewünschte Ordnung bzw. Priorisierung gebracht. Im ersten Beispiel war die Reihenfolge der Issues #1,#3,#4,#5,#6,#7 und für das Projekt unsortiert. Nach der Sortierung ist die Reihenfolge der Issues #7,#6,#5,#4,#3,#1 (Sortierung willkürlich gewählt und dient nur zu Anschauungszwecke).
98
99 [[image:ProductBacklog3.png||data-xwiki-image-style-border="true"]]
100
101 == Erstellung neuer Listen ==
102
103 In GitLab können die Listen auch genutzt werden um beispielsweise Meilensteine oder Epics darzustellen (siehe [[Meilensteine und Epics>>doc:Main.GitLab.WebHome||anchor="HMeilensteineundEpics"]]). Auch der Status der Issues kann dargestellt werden (siehe [[Status>>doc:Main.GitLab.WebHome||anchor="HStatusbeiIssues"]]). Hierfür wird einfach die **"New list"**-Funktion genutzt.
104
105 [[image:Liste1.png||data-xwiki-image-style-border="true"]]
106
107 In der sich öffnenden Option wird jetzt der Status **"in progress**" ausgewählt und mit der **"Add to board"**-Funktion bestätigt.
108
109 [[image:Liste2.png||data-xwiki-image-style-border="true"]]
110
111 [[image:Liste3.png||data-xwiki-image-style-border="true"]]
112
113 Zusätzlich werden zur Veranschaulichung Listen für die Meilensteine- und Epic-Label erstellt.
114
115 [[image:Liste4.png||data-xwiki-image-style-border="true"]]
116
117 [[image:Liste5.png||data-xwiki-image-style-border="true"]]
118
119 [[image:Liste6.png||data-xwiki-image-style-border="true"]]
120
121 ----
122
123 = Erstellung eines Sprints =
124
125 In GitLab erfolgt die Erstellung eines Sprints in sogenannten **"Iterationen"** (Wiederholungen). Diese Option ist in der Gruppennavigationsleiste unter dem Reiter **"Iteration" **vorzufinden. Um einen neuen Sprint zu erstellen wird die **"New iteration cadence"**-Option ausgewählt.
126
127 [[image:Iteration1.png||data-xwiki-image-style-border="true"]]
128
129 Damit ein neuer Sprint erstellt werden kann, wird der Sprint mit einem Titel, einem Start- sowie Enddatum und einer Beschreibung versehen. Das Sprintziel sollte in der Beschreibung festgehalten werden. Im unten aufgeführten Beispiel ist die Registrierung und die Anmeldung das angestrebte Sprintziel. Gespeichert wird der Sprint durch die "**Create milestone"**-Funktion
130
131
132 [[image:Sprint3.png||data-xwiki-image-style-border="true"]]
133
134 == Sprint-Backlog ==
135
136 Jetzt wurde erfolgreich ein Sprint erstellt. Jedoch fehlen bisher noch die Issues die benötigt werden um das Sprintziel zu erreichen. Dafür wird erneut der Reiter **"Issue boards" **(der Product-Backlog) angesteuert. Anschließend wird die Funktion **"New list"** ausgewählt.
137
138 [[image:Sprint4.1.png||data-xwiki-image-style-border="true"]]
139
140 Hierbei werden wieder verschiedene Optionen angeboten. Für die Erstellung eines Sprints bzw. der Durchführung der Sprintplanung, wird die Option **"Milestone"** und der eben erstellte Sprint als **"Value"** ausgewählt. Anschließend wird der Vorgang durch die **"Add to board"**-Funktion bestätigt.
141
142 [[image:Sprint5.png||data-xwiki-image-style-border="true"]]
143
144 [[image:Sprint6.1.png||data-xwiki-image-style-border="true"]]
145
146 Somit wurde erfolgreich ein sogenannter **Sprint-Backlog** (siehe [[Informationen zu Scrum>>doc:Main.Scrum.WebHome]]) erstellt. In der Sprint-Planungsphase wird vom kompletten Projektteam festgelegt, welche Issues im Sprint umgesetzt werden sollen um das selbst definierte Sprint-Ziel zu erreichen. Nachdem das Team sich geeinigt hat, werden die Issues aus dem Product-Backlog, per "Drag and Drop" (Ziehen und Ablegen) in dem Sprint-Backlog abgelegt.
147
148 [[image:Sprint8.png||data-xwiki-image-style-border="true"]]
149
150 == Schätzungen ==
151
152 Anschließend müssen die Issues geschätzt werden (siehe [[Schätzen>>doc:Main.Scrum.WebHome||anchor="HSchE4tzenvonAufwE4nden"]]). Dieser Vorgang dient der Schärfung des Verständnisses des gesamtem Projektteams. Hierbei ist es wichtig sich auf eine Werteskala (bspw. Fibonacci) zu einigen (diese sollte über die gesamte Projektdauer beibehalten werden). Die Ergebnisse werden dann direkt in den Issues unter dem Punkt "Weight" festgehalten.
153
154 [[image:SprintS.png||data-xwiki-image-style-border="true"]]
155
156 Die Sprint-Planung ist somit abgeschlossen und der fertiggestellte Sprint ist unter dem Reiter **"Milestones" **vorzufinden.
157
158 [[image:SprintE.png||data-xwiki-image-style-border="true"]]
159
160 [[image:SprintF.png||data-xwiki-image-style-border="true"]]
161
162 ----
163
164 = Erstellung eines Wikis =
165
166 Im Softwareprojekt müssen viele Daten dokumentiert (siehe [[Anforderungsanalyse>>doc:Main.Aufgabenstellung.WebHome||anchor="Teilaufgabe2:Anforderungsanalyse28Dokumentation29"]] und [[Entwurf>>doc:Main.Aufgabenstellung.WebHome||anchor="HTeilaufgabe3:Entwurf28Dokumentation29"]] sowie [[Dokumentation>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:Dokumentation"]]) werden und unter anderem auch ein Projekttagebuch (siehe [[Projekttagebuch>>doc:Main.Anforderungen Gruppen.WebHome||anchor="HProjekttagebuch"]] geführt werden. Dies wird in der Wiki-Funktion von GitLab umgesetzt. Diese Option ist in der Projektnavigationsleiste unter dem Reiter **"Wiki" **vorzufinden.
167
168 [[image:Wiki1.png||data-xwiki-image-style-border="true"]]
169
170 [[image:Wiki2.png||data-xwiki-image-style-border="true"]]
171
172 Im GitLab-Wiki muss die erste Seite die sogenannte **"Home"**-Seite sein. Sonst wird das Wiki nicht korrekt erzeugt. Die Seite wird mit der **"Create page"**-Funktion erstellt.
173
174 [[image:Wiki3.png||data-xwiki-image-style-border="true"]]
175
176 Um weitere Seiten zu erstellen, wird in der "Page"-Hierachie das "+" unter Home ausgewählt. Nach Erstellung der neuen Seite, wird diese wieder mit der **"Create page"**-Funktion erstellt.
177
178 [[image:Wiki4.png||data-xwiki-image-style-border="true"]]
179
180 (% class="wikigeneratedid" id="H" %)
181 [[image:Wiki5.png||data-xwiki-image-style-border="true"]]
182
183 ----
184
185 = Zeiterfassung in GitLab =
186
187 Im Rahmen des Softwareprojekts sollt ihr eure Arbeitszeit präzise festhalten. Dazu könnt ihr direkt auf angelegten Issues/Tasks/User Stories in dem Bereich **Time tracking** eure Arbeitszeit Aufgabenspezifisch eintragen. In dem Fenster könnt ihr eintragen wie viel Zeit ihr gearbeitet habt, an welchem Tag ihr gearbeitet habt, um nachträgliches verbuchen von Arbeitszeit zu ermöglichen, und eine kleine Zusammenfassung angeben. Sollte bereits Zeit erfasst worden sein, muss über das Plus (siehe Bild oben rechts im roten Rahmen) Zeit gebucht werden.[[image:1754139824426-497.png]]
188
189 ----
190
191 = GitLab Pipelines =
192
193 Eine GitLab Pipeline ist eine in //.gitlab-ci.yml// definierte Abfolge von Jobs. Jobs können dabei beispielsweise die automatische Ausführung von Tests sein.
194
195 == Pipeline im Basisprojekt v2 ==
196
197 Die Pipeline im Basisprojekt ist auf zwei Stages mit jeweils einem Job aufgeteilt und wird im Folgenden Schritt für Schritt erklärt. Ihr dürft im Rahmen des Softwareprojekts, wenn nötig, die Pipeline um weitere Jobs oder Stages erweitern. **Die bestehenden Jobs sollten allerdings **(von Studierenden) **nicht geändert werden.**
198
199 In der //.gitlab-ci.yml //werden zunächst die Stages definiert. Eine Stage ist eine logische Gruppe von Jobs, die in einem bestimmten Abschnitt der Pipeline ausgeführt werden. Jobs in einer Stage werden parallel ausgeführt, es sei denn es wird eine Abhängigkeit in den Jobs definiert.
200 Wenn alle Jobs in einer Stage (erfolgreich) abgeschlossen sind, startet die nächste Stage. Schlägt ein Job fehl wird die gesamte Pipeline gestoppt, außer es werden Jobs so markiert, dass sie fehlschlagen dürfen.
201
202 {{code language="yaml"}}
203 stages:
204 - verify
205 - deploy
206 {{/code}}
207
208 Der //verify-job //ist der erste Job, der in der Pipeline definiert ist. Er wird in der //verify-//Stage ausgeführt. Das Image ist ein Docker-Image, welches schon mit einer Java 21 Umgebung eingerichtet ist. Dadurch wird sichergestellt, dass der Job immer die gleiche Umgebung hat ("//but it works on my machine"//).
209 Im Script-Abschnitt wird dann mvn clean verify ausgeführt. Maven verify baut das Projekt und führt die Tests im Projekt aus.
210 Die Rules definieren, wann ein Job ausgeführt wird und ob das Fehlschlagen des Jobs erlaubt ist. Regeln werden von oben nach unten ausgewertet. //$CI_PIPELINE_SOURCE == "schedule" //sagt dass der Job bei automatischen Aufrufen über einen zeitgesteuerten Start der Pipeline mit besonderen Einschränkungen ausgeführt werden soll. //allow_failure// erlaubt in dem Fall, dass bei automatischer Ausführung die Pipeline nicht abgebrochen wird, falls sich euer Projekt nicht bauen lässt, damit darauffolgende Jobs weiterhin ausgeführt werden.
211
212 {{code language="yaml"}}
213 verify-job:
214 stage: verify
215 image: eclipse-temurin:21-jdk-alpine
216 script:
217 - "./mvnw clean verify"
218 rules:
219 - if: $CI_PIPELINE_SOURCE == "schedule"
220 when: always
221 allow_failure: true
222 - when: always
223 allow_failure: false
224 {{/code}}
225
226 (((
227 Der //deploy_stats_pages// Job ist der erste Job, der in der //deploy//-Stage ausgeführt wird. Der Job erfasst eure Projektarbeitsdaten (bspw. eure Stundenbuchungen) und veröffentlicht diese, nur für euch in GitLab sichtbar, in eurem Projekt.
228 Die Variablen sind Umgebungsvariablen, die zum Erfassen der Daten benötigt werden. **Die //TIME_FRAMES// Variable ist auskommentiert und sollte durch euren projektverantwortlichen Betreuer:in (Tutor:in) angepasst werden.** Durch die //TIME_FRAMES// Variable können die [[Einschätzungszeiträume>>https://xwiki.swl.informatik.uni-oldenburg.de/xwiki/bin/view/Main/Bewertung/#HBewertungszeitrE4ume]] sowie die "Soll-Zeit" pro Zeitraum gesetzt und für die Visualisierung verwendet werden.
229 Im Script-Bereich wird erst git installiert und dann die Projekete zur Erfassung und Visualisierung der Daten installiert.
230 Der Artifakt-Bereich definiert welche Dateien nach Ausführung des Jobs behalten werden. Der Public Ordner wird verwendet, um statische Websiten zu veröffentlichen. In diesem Fall die Visualisierung der erfassten Daten.
231 Im Gegensatz zum //verify-job// wird der //deploy_stats_pages//-Job **nur** ausgeführt, wenn die Pipeline zeitgesteuert gestartet wird.
232
233 {{code language="yaml"}}
234 deploy_stats_pages:
235 stage: deploy
236 image: maven:3.9.9-amazoncorretto-21-al2023
237 variables:
238 DEVELOPMENT_BRANCH_NAME: "development"
239 FETCH_MULTITHREAD: "true" #options are true/false
240 LOGLEVEL: "SHORT" #options are OFF, SHORT, LONG. Has an effect on the amount of logging when data is being added
241 #TIME_FRAMES: "01.01.2025,31.03.2025,40,Zeitraum01;01.04.2025,31.05.2025,35" #Format start,end,minHours[,name];anotherTimeframe;anotherTimeframe;...
242 script:
243 - yum install -y git rsync
244 - git clone https://gitlab.swl.informatik.uni-oldenburg.de/GA/gitlab2data.git
245 - cd gitlab2data
246 - mvn clean package
247 - java -jar target/GitLab2Data-1.0-SNAPSHOT-jar-with-dependencies.jar
248 - cd ..
249 - mkdir -p public/data
250 - rm -f public/data/*.json
251 - cp gitlab2data/*.json public/data/
252 - git clone https://gitlab.swl.informatik.uni-oldenburg.de/GA/data4visual.git repo
253 - rsync -av --exclude='data/' --exclude='.git' --exclude='.gitignore' repo/ public/
254 artifacts:
255 paths:
256 - public
257 pages:
258 path_prefix: "stats" #to allow for parallel deployments of the projects own page don't make the stats site the main deployment
259 expire_in: never
260 rules:
261 - if: $CI_PIPELINE_SOURCE == "schedule"
262 when: always
263 - when: never
264 {{/code}}
265
266 ----
267
268 = GitLab Pages (Einsehen der erfassten Projektdaten) =
269 )))
270
271 Wie im vorherigen Abschnitt beschrieben, werden im Softwareprojekt mit Hilfe der Pipeline Daten erfasst. Diese Daten können dann aus GitLab eingesehen werden, dazu kann man im Projekt über Deploy -> Pages und das Parallele Deployment "stats" die Daten einsehen.
272 [[image:Deploy->Pages.png||alt="Pages können im Projekt über Deploy -> Pages eingesehen werden"]][[image:ParallelDeploymentsStats.png||height="174" width="1226"]]
273
274 == User Overview ==
275
276 Auf der Seite User overview wird eine kompakte Übersicht aller Projektmitglieder dargstellt. Nutzer:innen werden nicht dargestellt, solange keine Zeitbuchung getätigt wurde.
277 [[image:Useroverview.png]]
278
279 == Timelogs ==
280
281 Unter Timelogs können einzelne Zeiteintragungen eingesehen werden. Dazu gibt es einige Filtermöglichkeiten, sowie die Möglichkeit nach Zeiträumen zu filtern. In Tabellenform lassen sich die Einträge einzelner Tage anklicken, um eine detailliertere Beschreibung einsehen zu können.
282
283 [[image:TimeLogs.png]]
284
285 == Request (und Review) Overview ==
286
287 Auf der Seite Request Overview können alle im Projekt erstellten Merge Requests eingesehen werden. Unter dem Diagramm ist zusätzlich eine Tabelle zu sehen, die neben der Anzahl im Diagramm noch weitere Informationen wie bspw. Titel und Status beinhaltet. Die Daten lassen sich nach Zielbranch (interessant ist hier Development) und Nutzer:in (durch einen Klick im Tortendiagramm) filtern. Die Seite Review Overview ist vom Verhalten analog gestaltet.
288
289 [[image:RequestOverview.png]]
290
291 == Code Contribution ==
292
293 Die Code Contribution Seite zeigt grafisch aufbereitete Informationen über die Menge an geschriebenem Code und die Zahl der Commits. Der Nutzer kann zwischen verschiedenen Diagrammtypen wählen (tägliche, monatliche oder Gesamtsummen für Code-nderungen bzw. Commits) und über Filter den dargestellten Zeitraum einschränken. Auch die Skalierung der Y-Achse kann angepasst werden.
294
295 [[image:Codecontribution.png]]
296
297 == Target Time ==
298
299 Die Target Time Seite ermöglicht die Auswertung der Arbeitszeit im Vergleich zur erwarteten Mindestarbeitszeit über definierte Zeiträume hinweg. Die Zeiträume müssen für eine Verwendung der Seite vom **Betreuer der Gruppe** (Tutor) in der GitLab Pipeline als Variable gesetzt sein (siehe Abschnitt zur Pipeline im Basisprojekt2). Wenn alles gesetzt ist, dann kann über die Seite eingesehen werden, wie viel Zeit im Verhältnis der erwarteten Zeit, ins Projekt investiert wurde. **Unter der roten Linie sollte keiner auf Dauer sein.**
300
301 [[image:TargetTime.png]]
302
303 ----
304
305