Wiki source code of GitLab Erklärungen

Version 133.1 by pmeyer on 2025/09/12 04:31

Hide last authors
Marco Grawunder 84.1 1 [[image:Main.Organisatorisches.WebHome@softwareprojekt_logo_transparent.png||alt="SoftwareprojektLogo.png" data-xwiki-image-style-alignment="end" height="136" width="309"]]
2
Pascal Meyer 12.1 3 {{toc/}}
4
Pascal Meyer 4.2 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.
Pascal Meyer 1.3 6
7 = Issue/Task-Erstellung in GitLab =
8
Pascal Meyer 6.2 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.
Pascal Meyer 4.2 10
Pascal Meyer 34.1 11 [[image:Issue1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 4.2 12
Pascal Meyer 5.2 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.
Pascal Meyer 4.2 14
Pascal Meyer 6.1 15 Als **"Type" **stehen drei Optionen zur Auswahl:
Pascal Meyer 5.2 16
Pascal Meyer 6.1 17 * "Incident" - Ein Zwischenfall/Störung
18 * "Issue" - Im SWP eine User-Story (siehe [[User-Stories>>doc:Main.Scrum.WebHome||anchor="HUserStories"]])
Pascal Meyer 6.2 19 * "Task" - Eine Aufgabe
Pascal Meyer 5.2 20
Pascal Meyer 7.1 21 Im unten gezeigtem Beispiel wird ein Issue gewählt und mit einem Titel (Name der User-Story) und einer Beschreibung (Akzeptanzkriterien) versehen.
Pascal Meyer 6.1 22
Pascal Meyer 8.2 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.
Pascal Meyer 6.1 24
Pascal Meyer 34.1 25 [[image:Issue2.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 11.1 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.
Pascal Meyer 7.2 28
Pascal Meyer 34.1 29 [[image:Issue3.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 7.2 30
Pascal Meyer 11.1 31 Hier wurde als Aufgabe das Feld für die Eingabe definiert. Anschließend wurde die Eingabe mit **"Create task"** bestätigt.
32
Pascal Meyer 33.6 33 [[image:Issue4.png||data-xwiki-image-style-border="true"]]
34
Pascal Meyer 11.1 35 Nachdem alle Informationen eingepflegt und ausführlich beschrieben wurden, ist das Issue vorerst fertig.
36
Pascal Meyer 33.6 37 [[image:Issue5.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 13.2 38
Pascal Meyer 52.5 39 == Status bei Issues ==
40
Pascal Meyer 52.6 41 In GitLab werden standardmäßig fünf verschiedene Statusformen angeboten. Diese Optionen sind:
Pascal Meyer 52.5 42
Pascal Meyer 52.6 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
Pascal Meyer 53.2 51 [[image:Issue Status 1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 52.6 52
Pascal Meyer 56.1 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.
Pascal Meyer 52.6 54
Pascal Meyer 55.2 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
Pascal Meyer 56.2 59 == Meilensteine und Epics ==
60
pmeyer 116.3 61 Im Laufe des Softwareprojektes werden eine Menge an Issues erstellt. Damit der Überblick über die Vielzahl an Issues nicht verloren geht und somit der Projektfortschritt nicht potenziell gefährdet wird, werden im Softwareprojekt mit Meilensteinen (siehe [[Meilensteine>>doc:Main.Anforderungen Software.WebHome||anchor="HAnforderungen:DievordefiniertenMeilensteine"]]) und Epics gearbeitet. In GitLab werden die Meilensteine mit der Funktion "**Milestones**" und die Labels mit der Funktion **"Labels"** umgesetzt. Diese Option ist im Reiter "Manage" und anschließend unter "Labels" vorzufinden.
Pascal Meyer 56.2 62
pmeyer 110.3 63 === Meilensteine ===
64
pmeyer 115.1 65 Um einen neuen Meilenstein zu erstellen, wird in der Projektnavigationsleiste der Reiter** "Milestones" **angeklickt und nachfolgend die Option **"New milestone"** ausgewählt.
pmeyer 114.2 66
pmeyer 113.2 67 [[image:Meilenstein1.1.png||data-xwiki-image-style-border="true"]]
pmeyer 110.3 68
pmeyer 115.1 69 Nach der Erstellung wird der Meilenstein mit einem Titel, einem Start- sowie Enddatum und einer Beschreibung versehen. In der Beschreibung müssen die umzusetzenden Funktionen aufgelistet werden (Ziel des Meilensteins). Bestätigt wird die Erstellung mit der "**Create milestone**"-Funktion.
70
pmeyer 113.2 71 [[image:Meilenstein2.png||data-xwiki-image-style-border="true"]]
72
pmeyer 114.2 73 [[image:Meilenstein3.png||data-xwiki-image-style-border="true"]]
pmeyer 113.2 74
pmeyer 128.2 75 Dem frisch erstellten Meilensteinen können jetzt Issues zugewiesen werden. Dies funktioniert trivial zu der Statusvergabe.
pmeyer 127.3 76
pmeyer 129.2 77 [[image:Meilenstein4.1.png||data-xwiki-image-style-border="true"]]
pmeyer 127.4 78
pmeyer 115.1 79 === Epics ===
80
pmeyer 116.4 81 Um ein neues Epic zu erstellen, wird in der Projektnavigationsleiste der Reiter** "Labels" **angeklickt und nachfolgend die Option **"New Label"** ausgewählt.
pmeyer 115.1 82
Pascal Meyer 58.2 83 [[image:Label 1.png||data-xwiki-image-style-border="true"]]
84
pmeyer 116.5 85 Das neue Epic wird mit einem Titel, einer Beschreibung und einer Farbe versehen. Bestätigt wird die Erstellung mit der "**Create label**"-Funktion.
Pascal Meyer 60.2 86
Pascal Meyer 63.2 87 [[image:Epic2.png||data-xwiki-image-style-border="true"]]
88
pmeyer 116.2 89 [[image:Label1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 63.2 90
pmeyer 116.6 91 Bei der Issue-Erstellung/Bearbeitung können die erstellten Labels/Meilensteine jetzt mit den neuen/bestehenden Issues verknüpft werden. Dies erfolgt trivial zur Status-Option.
Pascal Meyer 63.2 92
Pascal Meyer 68.1 93 [[image:Issue Label 2.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 63.3 94
pmeyer 118.2 95 [[image:Labelissue1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 68.1 96
pmeyer 118.2 97 [[image:Label2.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 68.1 98
sbeyer1 94.1 99 ----
100
Pascal Meyer 13.2 101 = Product-Backlog =
102
Pascal Meyer 33.6 103 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.
Pascal Meyer 17.1 104
Pascal Meyer 33.6 105 [[image:ProductBacklog1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 17.1 106
pmeyer 122.2 107 [[image:IssueList1.1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 33.6 108
Pascal Meyer 68.2 109 == Pflege/Priorisierung des Product-Backlogs ==
110
pmeyer 124.1 111 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 #8,#4,#9,#7,#1,#3, #5, #6 und für das Projekt unsortiert. Nach der Sortierung ist die Reihenfolge der Issues #9,#8,#7,#6,#5,#4, #3, #1 (Sortierung willkürlich gewählt und dient nur zu Anschauungszwecke).
Pascal Meyer 17.1 112
pmeyer 124.1 113 [[image:IssueList1.2.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 17.1 114
Pascal Meyer 70.2 115 == Erstellung neuer Listen ==
116
Pascal Meyer 78.2 117 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.
Pascal Meyer 70.2 118
pmeyer 125.1 119 [[image:IssueList2.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 78.2 120
Pascal Meyer 82.1 121 In der sich öffnenden Option wird jetzt der Status **"in progress**" ausgewählt und mit der **"Add to board"**-Funktion bestätigt.
Pascal Meyer 78.2 122
pmeyer 125.1 123 [[image:IssueList3.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 78.2 124
pmeyer 125.1 125 [[image:IssueList4.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 78.2 126
pmeyer 127.2 127 Zusätzlich werden zur Veranschaulichung Listen für die Epic-Label und Meilensteine erstellt.
Pascal Meyer 78.2 128
pmeyer 127.2 129 [[image:IssueList5.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 78.2 130
pmeyer 127.2 131 [[image:IssueList6.png||data-xwiki-image-style-border="true"]]
132
pmeyer 131.2 133 [[image:MeilensteinList1.png||data-xwiki-image-style-border="true"]]
pmeyer 127.2 134
pmeyer 131.2 135 [[image:MeilensteinList2.png||data-xwiki-image-style-border="true"]]
pmeyer 127.3 136
sbeyer1 94.1 137 ----
138
Pascal Meyer 18.3 139 = Erstellung eines Sprints =
Pascal Meyer 17.1 140
pmeyer 104.2 141 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.
Pascal Meyer 18.2 142
pmeyer 104.2 143 [[image:Iteration1.png||data-xwiki-image-style-border="true"]]
mgrawunder 101.3 144
pmeyer 108.2 145 Damit ein neuer Sprint erstellt werden kann, wird der Sprint mit einem Titel und einer optionalen Beschreibung versehen. Das Start- sowie Enddatum wird einmalig festgelegt. Anschließend wird die Dauer des Sprints in Wochen angegeben. Dieser Zeitraum ist für jeden weiteren Sprint fest. Desweiteren kann eingestellt werden, wie viele kommende Iterationen geplant werden können.  Die **"Roll over"** Funktion überträgt nicht fertiggestellte User Stories/Aufgaben automatisch in den nächsten Sprint. Mit der "**Create cadence"**-Funktion wird die Iteration und somit der Sprint erstellt.
Pascal Meyer 20.2 146
pmeyer 108.2 147 [[image:Iteration2.1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 20.2 148
pmeyer 110.1 149 [[image:Iteration3.1.png||data-xwiki-image-style-border="true"]]
pmeyer 107.2 150
Pascal Meyer 69.2 151 == Sprint-Backlog ==
152
Pascal Meyer 24.2 153 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.
Pascal Meyer 20.2 154
pmeyer 132.2 155 [[image:IssueList2.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 20.3 156
Pascal Meyer 24.4 157 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.
Pascal Meyer 22.1 158
Pascal Meyer 33.4 159 [[image:Sprint5.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 22.3 160
Pascal Meyer 33.3 161 [[image:Sprint6.1.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 24.2 162
Pascal Meyer 27.5 163 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.
Pascal Meyer 24.2 164
Pascal Meyer 33.3 165 [[image:Sprint8.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 24.3 166
Pascal Meyer 69.2 167 == Schätzungen ==
Pascal Meyer 26.1 168
Pascal Meyer 69.2 169 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.
170
Pascal Meyer 33.3 171 [[image:SprintS.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 27.5 172
Pascal Meyer 30.3 173 Die Sprint-Planung ist somit abgeschlossen und der fertiggestellte Sprint ist unter dem Reiter **"Milestones" **vorzufinden.
Pascal Meyer 30.2 174
Pascal Meyer 33.2 175 [[image:SprintE.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 30.3 176
Pascal Meyer 32.2 177 [[image:SprintF.png||data-xwiki-image-style-border="true"]]
178
sbeyer1 94.1 179 ----
180
Pascal Meyer 36.2 181 = Erstellung eines Wikis =
182
Pascal Meyer 83.1 183 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.
Pascal Meyer 37.2 184
185 [[image:Wiki1.png||data-xwiki-image-style-border="true"]]
186
Pascal Meyer 38.2 187 [[image:Wiki2.png||data-xwiki-image-style-border="true"]]
188
Pascal Meyer 39.3 189 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.
Pascal Meyer 39.2 190
191 [[image:Wiki3.png||data-xwiki-image-style-border="true"]]
Pascal Meyer 39.4 192
Pascal Meyer 43.1 193 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.
Pascal Meyer 39.5 194
Pascal Meyer 40.2 195 [[image:Wiki4.png||data-xwiki-image-style-border="true"]]
196
Sebastian Beyer 51.1 197 (% class="wikigeneratedid" id="H" %)
198 [[image:Wiki5.png||data-xwiki-image-style-border="true"]]
Sebastian Beyer 45.2 199
sbeyer1 85.1 200 ----
201
Sebastian Beyer 45.2 202 = Zeiterfassung in GitLab =
203
Sebastian Beyer 52.3 204 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]]
sbeyer1 84.2 205
206 ----
207
sbeyer1 84.4 208 = GitLab Pipelines =
209
sbeyer1 84.5 210 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.
211
sbeyer1 84.6 212 == Pipeline im Basisprojekt v2 ==
sbeyer1 84.5 213
sbeyer1 84.10 214 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.**
sbeyer1 84.6 215
sbeyer1 84.12 216 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.
217 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.
sbeyer1 84.10 218
sbeyer1 84.6 219 {{code language="yaml"}}
220 stages:
221 - verify
222 - deploy
223 {{/code}}
sbeyer1 84.12 224
sbeyer1 84.14 225 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"//).
226 Im Script-Abschnitt wird dann mvn clean verify ausgeführt. Maven verify baut das Projekt und führt die Tests im Projekt aus.
sbeyer1 84.15 227 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.
sbeyer1 84.12 228
229 {{code language="yaml"}}
230 verify-job:
231 stage: verify
232 image: eclipse-temurin:21-jdk-alpine
233 script:
234 - "./mvnw clean verify"
235 rules:
236 - if: $CI_PIPELINE_SOURCE == "schedule"
237 when: always
238 allow_failure: true
239 - when: always
240 allow_failure: false
241 {{/code}}
sbeyer1 84.15 242
sbeyer1 84.16 243 (((
sbeyer1 84.19 244 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.
sbeyer1 85.1 245 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.
sbeyer1 84.22 246 Im Script-Bereich wird erst git installiert und dann die Projekete zur Erfassung und Visualisierung der Daten installiert.
sbeyer1 84.23 247 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.
sbeyer1 84.24 248 Im Gegensatz zum //verify-job// wird der //deploy_stats_pages//-Job **nur** ausgeführt, wenn die Pipeline zeitgesteuert gestartet wird.
sbeyer1 84.16 249
250 {{code language="yaml"}}
251 deploy_stats_pages:
sbeyer1 84.15 252 stage: deploy
253 image: maven:3.9.9-amazoncorretto-21-al2023
254 variables:
255 DEVELOPMENT_BRANCH_NAME: "development"
256 FETCH_MULTITHREAD: "true" #options are true/false
257 LOGLEVEL: "SHORT" #options are OFF, SHORT, LONG. Has an effect on the amount of logging when data is being added
258 #TIME_FRAMES: "01.01.2025,31.03.2025,40,Zeitraum01;01.04.2025,31.05.2025,35" #Format start,end,minHours[,name];anotherTimeframe;anotherTimeframe;...
259 script:
260 - yum install -y git rsync
261 - git clone https://gitlab.swl.informatik.uni-oldenburg.de/GA/gitlab2data.git
262 - cd gitlab2data
263 - mvn clean package
264 - java -jar target/GitLab2Data-1.0-SNAPSHOT-jar-with-dependencies.jar
265 - cd ..
266 - mkdir -p public/data
267 - rm -f public/data/*.json
268 - cp gitlab2data/*.json public/data/
269 - git clone https://gitlab.swl.informatik.uni-oldenburg.de/GA/data4visual.git repo
270 - rsync -av --exclude='data/' --exclude='.git' --exclude='.gitignore' repo/ public/
271 artifacts:
272 paths:
273 - public
274 pages:
275 path_prefix: "stats" #to allow for parallel deployments of the projects own page don't make the stats site the main deployment
276 expire_in: never
277 rules:
278 - if: $CI_PIPELINE_SOURCE == "schedule"
279 when: always
sbeyer1 84.16 280 - when: never
281 {{/code}}
sbeyer1 85.1 282
283 ----
284
sbeyer1 85.2 285 = GitLab Pages (Einsehen der erfassten Projektdaten) =
286 )))
287
sbeyer1 94.1 288 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.
mgrawunder 101.3 289 [[image:Deploy->Pages.png||alt="Pages können im Projekt über Deploy -> Pages eingesehen werden"]][[image:ParallelDeploymentsStats.png||height="174" width="1226"]]
sbeyer1 94.1 290
291 == User Overview ==
292
293 Auf der Seite User overview wird eine kompakte Übersicht aller Projektmitglieder dargstellt. Nutzer:innen werden nicht dargestellt, solange keine Zeitbuchung getätigt wurde.
sbeyer1 100.2 294 [[image:Useroverview.png]]
sbeyer1 94.1 295
296 == Timelogs ==
297
298 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.
299
sbeyer1 98.2 300 [[image:TimeLogs.png]]
sbeyer1 94.1 301
302 == Request (und Review) Overview ==
303
304 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.
305
sbeyer1 99.2 306 [[image:RequestOverview.png]]
sbeyer1 94.1 307
308 == Code Contribution ==
309
310 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.
311
sbeyer1 96.2 312 [[image:Codecontribution.png]]
sbeyer1 94.1 313
314 == Target Time ==
315
316 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.**
317
sbeyer1 95.2 318 [[image:TargetTime.png]]
sbeyer1 94.1 319
320 ----
321
322