Skip to content

Commit fe89241

Browse files
committed
Improve help to find the console log
1 parent bf29573 commit fe89241

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

doc/Autograding.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Zum lokalen Starten dieser Analyse müssen Sie das Kommando `mvn clean verify` a
6969
4. Falls Sie eigenen Tests geschrieben haben: Wie gut ist die Qualität dieser Tests?
7070
Haben Sie alle Zeilen oder Zweige Ihres Codes benutzt (technisch: *Line und Branch Code Coverage*)?
7171
Finden Ihre Tests Fehler, wenn Ihr Programm von mir mutwillig sabotiert wird (technisch: *Mutation Coverage*)?
72-
Zum lokalen Starten dieser beiden Analysen müssen Sie das Kommando `mvn verify` (für die Code Coverage) bzw. `mvn versify -Ppit` (für die Mutation Coverage) ausführen.
72+
Zum lokalen Starten dieser beiden Analysen müssen Sie das Kommando `mvn verify` (für die Code Coverage) bzw. `mvn verify -Ppit` (für die Mutation Coverage) ausführen.
7373

7474
Für technisch Interessierte: Damit das ganze funktioniert, benötigt es eine [GitLab Autograding Pipeline](https://github.com/uhafner/autograding-gitlab-action/blob/main/.gitlab-ci.yml), die das Projekt kompiliert und dann mit meiner [Autograding GitLab Action](https://github.com/uhafner/autograding-gitlab-action) anreichert.
7575
Diese Action ist Open Source und kann gerne auch in anderen Projekte verwendet werden.
@@ -84,16 +84,26 @@ Dann finden Sie dort jeweils einen GitLab Kommentar mit den Ergebnissen.
8484

8585
![Autograding Kommentar](images/gitlab-autograding.png)
8686

87-
Wenn neben dem Commit ein grüner Haken (✅) angezeigt wird, haben Sie Schritt 1 schon mal erfolgreich absolviert: Ihr Programm kompiliert fehlerfrei. Bei einem roten Kreuz (❌) müssen Sie den Fehler beheben und nochmal neu hochladen. Eine Abgabe, die nicht übersetzbar ist, wird automatisch mit 0 Punkten bewertet. Die Fehlermeldungen des Java Compiler sind manchmal für Neulinge etwas kryptisch, meist steht aber Zeilennummer und Ursache dabei, sodass das Problem hoffentlich schnell zu finden ist. Wenn nicht, wenn Sie sich an uns im Chat oder Praktikum, dann bekommen Sie auch dort Hilfe.
87+
Wenn neben dem Commit ein grüner Haken (✅) angezeigt wird, haben Sie Schritt 1 schon mal erfolgreich absolviert: Ihr Programm kompiliert fehlerfrei.
88+
Bei einem roten Kreuz (❌) müssen Sie den Fehler beheben und nochmal neu hochladen.
89+
Die Ausgabe des Compilers finden Sie in der Konsole des jeweiligen GitLab Steps:
8890

89-
Die Ergebnisse der Schritte 2 bis 4 (und damit die eigentlichen Punkte Ihrer Abgabe) können Sie durch die Detailansicht des jeweiligen Commits einsehen. Dazu müssen Sie erst in die Detailsicht navigieren. Von dort haben Sie Zugriff auf das Ergebnis des Java Compilers. Dort müssen Sie nur hineinschauen, falls Sie hier ein rotes Kreuz sehen. Diese Ausgabe können Sie auch lokal über Maven erhalten (siehe oben):
91+
![Compiler Build Log](images/gitlab-console.png)
9092

91-
![Compiler Build Log](images/actions-buildlog.png)
93+
Eine Abgabe, die nicht übersetzbar ist, wird automatisch mit 0 Punkten bewertet.
94+
Die Fehlermeldungen des Java Compiler sind manchmal für Neulinge etwas kryptisch, meist steht aber Zeilennummer und Ursache dabei, sodass das Problem hoffentlich schnell zu finden ist.
95+
Wenn nicht, wenn Sie sich an uns im Chat oder Praktikum, dann bekommen Sie auch dort Hilfe.
9296

93-
Das wichtigste Ergebnis für die Abgabe ist dann die Zusammenfassung aus dem Autograding. Dort sehen Sie eine Punktezahl für die jeweilige Abgabe. Die Punkte berechnen sich aus den jeweils konfigurierten Bestandteilen: aus den Testergebnissen (Anzahl der Testfehler), aus den Warnungen der statischen Analyse und (falls konfiguriert) aus der Coverage Ihrer Testfälle. In den ersten Abgaben starten wir mit einer festen Punktezahl, von der jeweils Punkte bei Testfehlern oder bei Warnungen abgezogen werden. Im späteren Verlauf kann das auch umgekehrt funktionieren: also Start bei 0 und jeder erfüllte Test bekommt Pluspunkte.
97+
Die Ergebnisse der Schritte 2 bis 4 (und damit die eigentlichen Punkte Ihrer Abgabe) können Sie durch die Detailansicht einsehen.
98+
Das wichtigste Ergebnis für die Abgabe ist dann die Zusammenfassung aus dem Autograding.
99+
Dort sehen Sie eine Punktezahl für die jeweilige Abgabe.
100+
Die Punkte berechnen sich aus den jeweils konfigurierten Bestandteilen: aus den Testergebnissen (Anzahl der Testfehler), aus den Warnungen der statischen Analyse und (falls konfiguriert) aus der Coverage Ihrer Testfälle.
101+
In den ersten Abgaben starten wir mit einer festen Punktezahl, von der jeweils Punkte bei Testfehlern oder bei Warnungen abgezogen werden.
102+
Im späteren Verlauf kann das auch umgekehrt funktionieren: also Start bei 0 und jeder erfüllte Test bekommt Pluspunkte.
94103

95104
![Test and Analysis Results](images/actions-autograding.png)
96105

97-
Bei Testfehlern wird die Ausgabe der Tests direkt unter den Testpunkten als ausklappbarer Text angezeigt. Bei den Warnungen erhalten Sie gezieltes Feedback direkt als Markierung innerhalb des Quelltextes.
106+
Bei Testfehlern wird die Ausgabe der Tests direkt unter den Testpunkten als ausklappbarer Text angezeigt.
107+
Bei den Warnungen erhalten Sie gezieltes Feedback direkt als Markierung innerhalb des Quelltextes.
98108

99109
![Annotation](images/actions-annotation.png)

doc/images/gitlab-console.png

293 KB
Loading

0 commit comments

Comments
 (0)