Skip to Content

Changes for page GitLab Erklärungen

Last modified by pmeyer on 2025/09/12 04:41
From version arrow_back 84.11 arrow_forward
edited by sbeyer1
on 2025/08/25 11:35
Change comment: There is no comment for this version
To version arrow_back 84.22 arrow_forward
edited by sbeyer1
on 2025/08/25 12:09
Change comment: There is no comment for this version

Summary

Details

insert_drive_file Page properties
Content
... ... @@ -189,7 +189,8 @@
189 189  
190 190  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.**
191 191  
192 -In der //.gitlab-ci.yml //werden zunächst die Stages definiert. Eine Stage ist eine logische Gruppe von Jobs, die in einem bestimmten Abschnitt
192 +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.
193 +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.
193 193  
194 194  {{code language="yaml"}}
195 195  stages:
... ... @@ -196,3 +196,61 @@
196 196   - verify
197 197   - deploy
198 198  {{/code}}
200 +
201 +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"//).
202 +Im Script-Abschnitt wird dann mvn clean verify ausgeführt. Maven verify baut das Projekt und führt die Tests im Projekt aus.
203 +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.
204 +
205 +{{code language="yaml"}}
206 +verify-job:
207 + stage: verify
208 + image: eclipse-temurin:21-jdk-alpine
209 + script:
210 + - "./mvnw clean verify"
211 + rules:
212 + - if: $CI_PIPELINE_SOURCE == "schedule"
213 + when: always
214 + allow_failure: true
215 + - when: always
216 + allow_failure: false
217 +{{/code}}
218 +
219 +(((
220 + 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.
221 +Die Variablen sind Umgebungsvariablen, die zum Erfassen der Daten benötigt werden. **Die //TIME_FRAMES// Variable ist auskommentiert und sollte durch euren projektverantwortlichen Betreuer (Tutor) 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.
222 +Im Script-Bereich wird erst git installiert und dann die Projekete zur Erfassung und Visualisierung der Daten installiert.
223 +Der Artifakt-Bereich definiert welche Dateien nach Ausführung des Jobs behalten werden. Der Public Ordner wird verwendet, um
224 +
225 +{{code language="yaml"}}
226 +deploy_stats_pages:
227 + stage: deploy
228 + image: maven:3.9.9-amazoncorretto-21-al2023
229 + variables:
230 + DEVELOPMENT_BRANCH_NAME: "development"
231 + FETCH_MULTITHREAD: "true" #options are true/false
232 + LOGLEVEL: "SHORT" #options are OFF, SHORT, LONG. Has an effect on the amount of logging when data is being added
233 + #TIME_FRAMES: "01.01.2025,31.03.2025,40,Zeitraum01;01.04.2025,31.05.2025,35" #Format start,end,minHours[,name];anotherTimeframe;anotherTimeframe;...
234 + script:
235 + - yum install -y git rsync
236 + - git clone https://gitlab.swl.informatik.uni-oldenburg.de/GA/gitlab2data.git
237 + - cd gitlab2data
238 + - mvn clean package
239 + - java -jar target/GitLab2Data-1.0-SNAPSHOT-jar-with-dependencies.jar
240 + - cd ..
241 + - mkdir -p public/data
242 + - rm -f public/data/*.json
243 + - cp gitlab2data/*.json public/data/
244 + - git clone https://gitlab.swl.informatik.uni-oldenburg.de/GA/data4visual.git repo
245 + - rsync -av --exclude='data/' --exclude='.git' --exclude='.gitignore' repo/ public/
246 + artifacts:
247 + paths:
248 + - public
249 + pages:
250 + path_prefix: "stats" #to allow for parallel deployments of the projects own page don't make the stats site the main deployment
251 + expire_in: never
252 + rules:
253 + - if: $CI_PIPELINE_SOURCE == "schedule"
254 + when: always
255 + - when: never
256 +{{/code}}
257 +)))