Övning – Lägga till en regel för att kräva en granskning

  • 9 minuter

I den här lektionen konfigurerar du en regel på GitHub som kräver att en granskare godkänner ändringar innan de kan sammanfogas till grenen main . Som en bonus kan du även åtgärda skrivfelet på webbplatsens startsida för Space Game .

För närvarande tillåter teamet att alla som skickar en pull-begäran sammanslår koden till main-grenen. Eftersom ingen granskning krävs är det möjligt att felaktig eller instabil kod kryper in.

Andy vill lägga till en kontroll i pull-begäran i form av en extra granskare. Han vill konfigurera GitHub för att kräva att någon annan än pull-begärandeförfattaren granskar koden innan den slås samman. Vi tittar på hur det går till.

Andy letar efter Mara och ser att hon arbetar vid sitt skrivbord och nickar i takt med musiken i hörsnäckorna.

Mara, jag har tänkt prata med dig om något.

Mara tittar upp.

Mara: Vad kan jag hjälpa dig med?

Andy: Flera små misstag gör det genom bygget. Just i dag visades ett skrivfel på startsidan. Amita lägger ned för mycket tid på sådana här saker. Vi behöver stoppa felen innan de förs in i main-grenen. Vi behöver en till person som granskar koden innan pull-begäran godkänns.

Mara: Jag kan ställa in det. I GitHub finns det ett sätt att se till att ingen pull-begäran slås samman innan någon annan granskar och godkänner den.

Konfigurera godkännanden

I det här avsnittet konfigurerar du en regel på GitHub som kräver att minst en granskare godkänner en pull-begäran innan den kan sammanfogas till grenen main . Sedan kontrollerar du att regeln fungerar genom att skicka en korrigering till det skrivfel som Mara gjorde tidigare.

Lägga till regeln

  1. I GitHub går du till din Space Game-projektlagringsplats .
  2. Välj fliken Inställningar längst upp på sidan.
  3. Välj Grenar på den vänstra menyn.
  4. Kontrollera att main har valts som standardgren.
  5. Välj Lägg till grenskyddsregel.
  6. Under mönstret Förgreningsnamn anger du main.
  7. Markera kryssrutan Kräv en pull-begäran innan du slår samman.
  8. Markera kryssrutan Kräv godkännanden .
  9. Behåll värdet För godkännande av granskningar som krävs på 1.
  10. Välj Skapa.
  11. Välj Spara ändringar.

Kommentar

Längst ned i listan över alternativ finns alternativet Include Administrators (Inkludera administratörer). Det här alternativet kräver att databasadministratörer följer regeln. Du anger inte det eftersom du är administratör för din lagringsplats och det inte finns någon annan granskare. I den här utbildningsenheten granskar och godkänner du dina egna pull-begäranden.

Skicka åtgärden

I det här avsnittet skickar du en korrigering till skrivfelet på startsidan. Kom ihåg att ordet "officiell" är feltypat som "oficial".

Skärmbild av webbplatsen Space Game som visar ett skrivfel.

  1. I Visual Studio Code går du till terminalen.

  2. Om du vill checka ut grenen main kör du git checkout:

    git checkout main

  3. Om du vill hämta de senaste ändringarna i grenen main från GitHub kör du git pull:

    git pull origin main

    Du kan se att två filer uppdateras:

    • README.md: Innehåller Markdown-koden för att visa byggmärket.
    • Index.cshtml: Innehåller den uppdaterade startsidestexten, som innehåller skrivfelet.

  4. Åtgärda felet genom att skapa och checka ut en gren:

    git checkout -B bugfix/home-page-typo

  5. Öppna Index.cshtml i Utforskaren.

  6. Leta upp felet:

    <p>Welcome to the oficial Space Game site!</p>

  7. Ändra raden för att korrigera felet:

    <p>Welcome to the official Space Game site!</p>

  8. Spara filen.

  9. I terminalen mellanlagra och genomför du ändringen:

    git status
git add Tailspin.SpaceGame.Web/Views/Home/Index.cshtml
git commit -m "Fix typing error on the home page"

    I praktiken skulle du vanligtvis skapa och köra webbplatsen lokalt för att verifiera ändringen. I den här lektionen ska vi hoppa över det steget för korthets skull.

  10. Skicka grenen till GitHub.

    git push origin bugfix/home-page-typo

Testa regeln

  1. Leta upp och välj grenen i bugfix/home-page-typo GitHub.

    Skärmbild av GitHub som visar den nyligen push-överförda grenen.

  2. Starta pull-begäran genom att välja Bidra och sedan Öppna pull-begäran.

  3. Ange den förgrenade lagringsplatsen som baslagringsplats.

    Skärmbild av GitHub som bekräftar att grenen kan sammanfogas.

  4. Välj Skapa pull-begäran.

    Du kan se att en mänsklig granskning krävs innan du kan sammanfoga ändringen.

    Skärmbild av en pull-begäran på GitHub som visar att en granskning krävs för att sammanfogas.

    I praktiken tilldelar du en gruppmedlem för att granska ändringen. I den här lektionen kan du slå samman din egen pull-begäran i utbildningssyfte.

  5. Markera kryssrutan Koppla utan att vänta på att kraven ska uppfyllas (kringgå grenskydd) och välj sedan Slå samman pull-begäran.

  6. Välj Bekräfta sammanslagning.

    Ändringen sammanslås.

  7. Om du vill ta bort grenen bugfix/home-page-typo väljer du Ta bort gren.