Gör en PR

Följ denna instruktionen för att göra en pull request (PR) för att lämna in uppgiften i kmom03, kmom06 och kmom10.

Förutsättning

Du har uppfyllt kraven i uppgiften och har gjort en vanlig inlämning enligt Resultat och redovisning.

Ordlista

PR: Pull request
Tests passed(TP): Får din PR när de automatiska testerna gått igenom. Nu ska du bara vänta på att en lärare kollar på din inlämning.
Tests failed: Får din PR när något gått fel i de automatiska testerna. Ladda ner testerna igen, fixa felet lokalt och pusha till GitHub.
Grade: G: Helt klar med en uppgift.
Grade: Ux: En lärare har bedömt din inlämning men tycker att något behöver förbättras i din inlämning. Följ instruktionerna, fixa problemet lokalt och pusha din lösning till GitHub. När du taggar så körs testerna på GitHub.
Grade: U: En lärare har bedömt din inlämning men tycker inte att det är tillräckligt bra. Du behöver göra en ny inlämning till nästa rättningstillfälle.
Run tests: Du ska sätta labeln “Run tests” för att köra igång flödet som kör testerna och sätter Tests Passed (TP) eller Tests failed.
Integration failed: Något i koden som kör de automatiserade testerna gick fel. Dubbelkolla att du är inloggad med SSO och har auktoriserat din SSH-nyckel. Kontakta en lärare.

Mitt eget arbete

Det du lämnar in är ditt eget arbete. Om du har tagit hjälp av extern kod, eller om du har kopierat någon mindre del av koden, så är det tydligt angivet i kommentarerna i koden eller i din redovisningstext.

I samband med att du gör din PR så intygar du att arbetet är ditt eget och uppfyller de regler som finns för “Fusk och medveten vilseledning”.

Pull request (PR)

Du skall nu göra din inlämning som en PR mot följande branch. En lärare rättar din PR på dessa inlämningsbrancher, exempelvis rättas kmom03 i inlämningsbranchen bth/submit/kmom03.

PR kmom03 mot bth/submit/kmom03
PR kmom06 mot bth/submit/kmom06
PR kmom10 mot bth/submit/kmom10

Följ stegen nedan för att skapa en PR.

Gå till din kod på GitHub

Du gör detta med hjälp av GitHub. Se till att du har pushat ditt lokala kursrepo till GitHub och öppna ditt kursrepo på GitHub i webbläsaren.
Klicka på “Pull requests” i navbaren.

Gå till Pull requests

När du har klickat på “Pull requests” i navbaren, så ser det ut så här.

Klicka på “New Pull Request”.

Förbered att skapa en ny PR

När du har klickat på “New Pull Request”, så ser det ut så här.

Välj brancher att jämföra

Nu skall du välja vilken branch du vill skapa en PR mot.

Din “base” skall vara bth/submit/kmom0<X> (3 för kmom03 och 6 för kmom06) (1 i bilden).

Din “compare” skall vara main (2 i bilden).

Det betyder att du vill merga main in till bth/submit/kmom0X.

Nu är du redo att skapa en PR, klicka på “Create pull request” (3 i bilden).

Öppna en PR mot en branch

När du har klickat på “Create pull request” så skall du fylla i detaljer om din PR:

Som titel skriver du “Inlämning av kmom0<X>” (1 i bilden).

Som assignees lägger du in dig själv. (2 i bilden).

Nu kan du lägga till din PR genom att klicka på knappen “Create pull request” (3 i bilden).

En ny PR är öppnad

När din PR är öppnad kan det se ut så här:

Tester

Vänta ett par minuter, skrolla sen ner för att se att testerna har godkänts. Titta efter labeln Test passed (TP).

Du får även en sammanfattning på valideringen av taggarna och resultatet av testerna:

På bilden ovanför kan du se hur det ser ut när allt är OK. Testerna har lyckats och din inlämning är registrerad i Canvas.
Om något gick fel, kanske fick du Test failed eller att taggarna inte var ok, se Något fick fel.

Sista stegen (PR)

Nu har du två punkter kvar:

Kolla att du har fått TP i Canvas på kmom0<X> inlämningen (kan ta några minuter)
Skapa en branch för nästa inlämning, exempelvis har du precis lämnat in kmom03, skapar du en branch för kmom06.

git checkout -b bth/submit/kmom06 && git push origin bth/submit/kmom06
git checkout main
git branch # ok om stjärnan är framför main

Om du precis lämnat in kmom06, kör du ovanstående kommandon med kmom10 istället för kmom06.

Kontrollera nya branchen

Dubbelkolla att den nyss skapade branchen finns med:

i ditt lokala kursrepo; med git branch då ska branchen synas, exempelvis om du precis skapade bth/submit/kmom06 så syns den och main (main har en stjärna framför vilket visar att du är på main).
När du har klickat så ser det ut så här:

i ditt kursrepo på GitHub; klicka på “Branches” för att se att dina brancher.

När du har klickat så ser det ut så här:

Något gick fel

Om något gick fel med tester eller validering får du betyg Test failed på Canvas.

Om något gick fel med testerna får du en kommentar om vad som gick fel samt din PR får labeln Tests failed och PR:n stängs. Eftersom du kör testerna när du taggar så bör detta inte inträffa.

Vanliga fel:

du har inte de nyaste filerna eller testerna
du inte inloggad med SSO (logga ut och sen in igen och klicka på SSO-knappen på rätt organisation)

Nu behöver du kolla vad som gick fel, fixa felet och ladda upp koden igen.

Fixa dina fel

Ladda ner testerna på nytt och kör dem lokalt (kör uv run task download-all)
Rätta felet och testkör lokalt.
Pusha din rättning till GitHub och tagga den
Skapa en ny PR för att köra igång flödet som kör testerna och sätter Tests Passed (TP) eller Tests failed.

Om du får något annat konstigt fel du inte förstår, kolla om felet finns med nedanför i Vanliga fel annars kontakta en lärare och be om hjälp.

Feedback och bedömning

När läraren rättar din PR så får du återkoppling i kommentarer till din PR.

Approved / G

Om läraren tycker att allt ser bra ut får du en kommentar, label Approved och G i Canvas. Lärare mergar och stänger då din PR. Du kan jobba vidare med nästa kmom.

Needs improvement / Ux

Om läraren tycker att något är fel som du behöver fixa får du label Needs improvement och Ux på Canvas. Din PR är forsatt öppen.
Det kommer finnas kommentarer på specifika kodrader. Om kommentaren innehåller en Warning som på bilden nedanför, då måste du åtgärda det i din kod. Om kommentaren inte innehåller Warning behöver du inte åtgärda det som står där.

OBS Låt kommentaren vara kvar! Om du vill svara på kommentaren, så går det bra.

När du har åtgärdat felen gör följande:

Rätta felet och testkör lokalt.
Pusha din rättning till GitHub och tagga den. Om din fix funkade ska du nu få labeln Tests passed(TP).
Lägg till labeln Run tests på din öppna PR för att köra igång flödet som kör testerna och sätter Tests Passed (TP) eller Tests failed. Låt labeln Grade: Ux vara kvar.

Submission not approved / U

Om åtgärderna du gjorde i Re-submitted bedöms att inte vara tillräckliga får du label Submission not approved och U i Canvas. Det kommer finnas kommentarer som förklara felet och läraren kommer stänga din PR.

I kmom10, vid större fel, ges inte komplettering. Då kan du få U direkt.

Din inlämning kommer inte rättas mer. Din PR stängs. Du behöver göra en ny PR till nästa rättningstillfälle. I studieplanen hittar du när nästa rättningstillfälle är.

Vanliga fel

Ett testfall gick fel

Om ett testfall går fel här, så saknar du de nyaste testfallen. Om du missat stegen i Resultat och redovisning så gör du det nu.

Så här ser det ut om du klickar under “Actions” i navbaren överst på GitHub:

För att få mer information klickar du in på den action som gick rött, i det här fallet “Fix errors in testcase kmom01”. Då ser det ut så här:

För att få mer information om felet, klickar du på “call-on-tag / on-tag / run-kmoms (tests/kmom01/convert)” under Annotations. Då ser det ut så här:

Nu ser jag att ett testfall gått fel, som jag missat i testerna lokalt. Då gör jag enligt instruktionerna under Fixa dina fel.

Gammal tag

Din senaste kod ska vara taggad med en ny tag, annars klagar valideringen. Se hur i Resultat och redovisning.