Pull requests

Det här lär du dig

• Vad en pull requestpull requestPull request (PR)Ett förslag om att föra in ändringarna från en branch i en annan, så att andra kan granska och diskutera dem först.Läs mer om pull request är, och vad den visar.
• Att öppna en pull request från en gren som du har skickat till GitHub.
• Att skriva en beskrivning, och koppla pull requesten till en issue med Closes #1.

Varför behövs det här?

I modul 4 och 5 gjorde du själv git merge och skickade main. Då kommer ändringen in utan att någon annan har sett den. En pull request är ett förslag i stället: här är mina ändringar, vill ni föra in dem? Ingenting ändras i main förrän förslaget är godkänt.

Så hänger det ihop

En pull request, förkortat PR, gäller två grenargrenarBranchEn egen utvecklingslinje i ett repository, där man kan göra ändringar utan att påverka huvudversionen.Läs mer om grenar:

• base: grenen som ändringarna ska föras in i, nästan alltid main
• compare: din gren med ändringarna

GitHub visar skillnaden mellan dem, med samma + och - som git diff, och samlar beskrivning, kommentarer och granskning på ett ställe.

Pull requesten följer grenen. Gör du fler commits på grenen och kör git push, kommer de automatiskt med i samma pull request. Du behöver aldrig öppna en ny.

Koppla till en issue

Skriver du Closes #1 i beskrivningen kopplas pull requesten till issue nummer 1. När pull requesten förs in i main stängs issuen automatiskt. Fixes #1 och Resolves #1 fungerar likadant.

Exempel

Grenen för uppgiften skapas och skickas som i modul 5:

Terminal

$ git switch -c dag-3-gavle
Switched to a new branch 'dag-3-gavle'
$ git add resplan.txt
$ git commit -m "Lägg till dag 3: Gävle"
[dag-3-gavle 27de834] Lägg till dag 3: Gävle
 1 file changed, 1 insertion(+)
$ git push -u origin dag-3-gavle

En bra beskrivning av pull requesten säger vad ändringen gör, varför, och vad granskaren bör titta på:

Beskrivning

Lägger till Gävle som dag 3, mellan Uppsala och Sundsvall.

Kontrollera gärna att dagarna fortfarande står i rätt ordning.

Closes #1

Så fungerar det: utkast

Vill du visa en pull request innan du är klar kan du öppna den som utkast (draft). Ett utkast kan inte föras in förrän du markerar det som klart. Välj det i menyn bredvid knappen när du skapar pull requesten.

Övning

Gör så här: öppna en pull request

1. Gå till din mapp för modulen. Hämta det senaste: git switch main och git pull.
2. Skapa en gren för issuen från förra lektionen: git switch -c dag-3-gavle.
3. Gör ändringen som issuen beskriver, gör en commit och skicka grenen: git push -u origin dag-3-gavle.
4. Öppna repositoryt på GitHub. Ovanför filerna visas en gul ruta om grenen du just skickade. Klicka på Compare & pull request.
5. Kontrollera att base är main och compare är dag-3-gavle.
6. Skriv en titel och en beskrivning. Avsluta beskrivningen med Closes #1, med numret på din issue.
7. Klicka på Create pull request.
8. Öppna fliken Files changed och se skillnaden.

För inte in pull requesten än. Den ska granskas först, i nästa lektion.

Vanliga problem

Om det inte fungerar: jag ser ingen gul ruta med Compare & pull request

Rutan visas bara en stund efter att du har skickat en gren. Välj fliken Pull requests och klicka på New pull request i stället. Välj main som base och din gren som compare.

Om det inte fungerar: There isn't anything to compare

Grenarna är likadana. Kontrollera att din commit finns på grenen, och att du har skickat den med git push. Kontrollera också att du jämför rätt grenar.

Om det inte fungerar: pull requesten innehåller commits som inte hör dit

Grenen skapades inte från main, eller från en gammal main. Börja alltid med git switch main och git pull innan du skapar en ny gren.

Testa dig själv

1. Vad händer med main när du öppnar en pull request?

• Ingenting, förrän pull requesten förs in
• Ändringen förs in direkt
• main låses tills pull requesten är granskad

Visa rätt svar

• Ingenting, förrän pull requesten förs in: En pull request är bara ett förslag.

2. Du har fått synpunkter och rättar på samma gren. Vad gör du sedan?

• Gör en commit och kör git push – den nya commiten kommer med i samma pull request
• Öppnar en ny pull request
• Tar bort pull requesten och börjar om

Visa rätt svar

• Gör en commit och kör git push – den nya commiten kommer med i samma pull request

3. Vad gör "Closes #1" i beskrivningen av en pull request?

• Stänger issue nummer 1 när pull requesten förs in i main
• Stänger pull requesten direkt
• Tar bort grenen

Visa rätt svar

• Stänger issue nummer 1 när pull requesten förs in i main

Rätta

Sammanfattning

• En pull request är ett förslag om att föra in en gren (compare) i en annan (base), oftast main.
• Ingenting ändras i main förrän pull requesten förs in.
• Nya commits på grenen kommer automatiskt med i samma pull request efter git push.
• Closes #1 i beskrivningen stänger issue nummer 1 när pull requesten förs in i main.