Oefening: een regel toevoegen om een beoordeling te vereisen

  • 9 minuten

In deze les stelt u een regel in op GitHub waarvoor een revisor wijzigingen moet goedkeuren voordat deze kunnen worden samengevoegd met de main vertakking. Als bonus lost u ook de typefout op de startpagina van de Space Game-website op.

Op dit moment staat het team iedereen die een pull-aanvraag doet toe om de code samen te voegen in de main-vertakking. Omdat er geen controle is vereist, is het mogelijk dat er onjuiste of onstabiele code binnensluipt.

Andy besluit dat hij een controle aan de pull-aanvraag wil toevoegen in de vorm van een extra revisor. Hij wil GitHub zo instellen dat iemand anders dan de auteur van de pull-aanvraag de code moet controleren voordat deze wordt samengevoegd. We gaan kijken hoe u dit doet.

Andy gaat eerst op zoek naar Mara en vindt haar aan het werk, haar hoofd mee bewegend op het ritme van de muziek die ze via haar oordopjes beluistert.

Andy: Mara, ik heb zin gehad om met je te praten over iets.

Mara kijkt op.

Mara: Waar kan ik je mee helpen?

Andy: Verschillende kleine fouten maken het door de build. Vandaag de dag verschijnt er een typefout op de startpagina. Amita besteedt te veel tijd aan deze dingen. We moeten dit stoppen voordat ze terechtkomen in de main-vertakking. We moeten ervoor zorgen dat iemand de code nakijkt voordat de pull-aanvraag wordt goedgekeurd.

Mara: Ik kan dat instellen. In GitHub is er een manier om ervoor te zorgen dat er geen pull-aanvraag wordt samengevoegd voordat iemand anders deze beoordeelt en goedkeurt.

Goedkeuringen instellen

In deze sectie stelt u een regel in op GitHub waarvoor ten minste één revisor een pull-aanvraag moet goedkeuren voordat deze kan worden samengevoegd met de main vertakking. Vervolgens controleert u of de regel werkt door een oplossing te pushen naar de typefout die Mara eerder heeft gemaakt.

De regel toevoegen

  1. Ga in GitHub naar uw Space Game-projectopslagplaats .
  2. Selecteer het tabblad Instellingen boven aan de pagina.
  3. Selecteer Vertakkingen in het linkermenu.
  4. Zorg ervoor dat het hoofdgedeelte is geselecteerd als uw standaardbranch.
  5. Selecteer Vertakkingsbeveiligingsregel toevoegen.
  6. Voer onder Vertakkingsnaampatroon de hoofdtekst in.
  7. Schakel het selectievakje Een pull-aanvraag vereisen in voordat u samenvoegt .
  8. Schakel het selectievakje Goedkeuringen vereisen in.
  9. Behoud de waarde voor vereiste goedkeuringsbeoordelingen op 1.
  10. Selecteer Maken.
  11. Selecteer Wijzigingen opslaan.

Notitie

Op de onderkant van de lijst met opties staat een optie met de naam Include Administrators (Inclusief beheerders). Voor deze optie moeten opslagplaatsbeheerders de regel volgen. U stelt dit niet in, omdat u een beheerder van uw opslagplaats bent en er geen andere revisor is. In deze les beoordeelt en keurt u uw eigen pull-aanvragen goed voor leerdoeleinden.

De oplossing verzenden

In deze sectie verzendt u een oplossing voor de typefout op de startpagina. Houd er rekening mee dat het woord 'official' verkeerd is getypt als 'oficial'.

Screenshot of the Space Game website showing a typing error.

  1. Ga in Visual Studio Code naar de terminal.

  2. Als u de vertakking wilt uitchecken, voert u het main volgende uit git checkout:

    git checkout main

  3. Als u de meest recente wijzigingen in de main vertakking wilt ophalen vanuit GitHub, voert u het volgende uit git pull:

    git pull origin main

    U kunt zien dat twee bestanden worden bijgewerkt:

    • README.md: bevat de Markdown-code voor het weergeven van de buildbadge.
    • Index.cshtml: bevat de bijgewerkte tekst van de startpagina, die de typefout bevat.

  4. U kunt de fout oplossen door een vertakking te maken en uitchecken:

    git checkout -B bugfix/home-page-typo

  5. Open Index.cshtml in Bestandenverkenner.

  6. Zoek de fout op:

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

  7. Wijzig de regel om de fout te corrigeren:

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

  8. Sla het bestand op.

  9. Faseer en voer de wijziging door in de terminal:

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

    In de praktijk zou u de site gewoonlijk lokaal bouwen en uitvoeren om de wijziging te controleren. In deze les gaan we die stap om kortheid over te slaan.

  10. Push de vertakking naar GitHub.

    git push origin bugfix/home-page-typo

De regel testen

  1. Zoek en selecteer de bugfix/home-page-typo vertakking in GitHub.

    Screenshot of GitHub showing the recently pushed branch.

  2. Als u uw pull-aanvraag wilt starten, selecteert u Bijdragen en opent u vervolgens een pull-aanvraag.

  3. Stel uw gevorkte opslagplaats in als de basisopslagplaats.

    Screenshot of GitHub confirming that the branch can be merged.

  4. Selecteer Pull-aanvraag maken.

    U kunt zien dat een menselijke beoordeling vereist is voordat u de wijziging kunt samenvoegen.

    Screenshot of a pull request on GitHub showing that a review is required in order to merge.

    In de praktijk wijst u een teamlid toe om uw wijziging te controleren. In deze les kunt u uw eigen pull-aanvraag samenvoegen voor leerdoeleinden.

  5. Schakel het selectievakje Samenvoegen in zonder te wachten tot aan de vereisten is voldaan (beveiliging van vertakkingen overslaan) en selecteer vervolgens Pull-aanvraag samenvoegen.

  6. Selecteer Samenvoegen bevestigen.

    Uw wijziging wordt samengevoegd.

  7. Als u de bugfix/home-page-typo vertakking wilt verwijderen, selecteert u Vertakking verwijderen.