Cvičení – přidání pravidla, které vyžaduje revizi

  • 9 min

V této lekci nastavíte pravidlo na GitHubu, které vyžaduje, aby revidujícím změny schválil, než je bude možné sloučit do main větve. Jako bonus také opravíte chybu při psaní na domovské stránce webu Space Game .

V současné době tým umožňuje, aby kdokoliv vytvořil žádost o přijetí změn a sloučil kód do větve main. Vzhledem k tomu, že není vyžadována žádná kontrola, je možné, že se nesprávný nebo nestabilní kód vyloučí.

Andy rozhodne, že chce k žádostem o přijetí změn přidat revizi dalším párem očí. Chce nastavit GitHub tak, aby před sloučením vyžadoval někoho jiného než autora žádosti o přijetí změn. Pojďme se podívat, jak se to dá udělat.

Andy hledá Maru a najde ji u jejího stolu, jak pilně pracuje a hlavou přitom pokyvuje do rytmu hudby ze svých sluchátek.

Andy: Mara, chtěla jsem s tebou mluvit o něčem.

Mara na něj vzhlédne.

Mara: S čím vám můžu pomoct?

Andy: Několik malých chyb to dělá v sestavení. Právě dnes se na domovské stránce objevila chyba při psaní. Amitě tyto věci zabírají příliš mnoho času. Potřebujeme takové chyby zastavit ještě předtím, než se dostanou do větve main. Potřebujeme, aby se na kód před schválením žádosti o přijetí změn podívala další osoba.

Mara: Můžu to nastavit. Na GitHubu existuje způsob, jak zajistit, aby se žádná žádost o přijetí změn sloučila, než ji někdo jiný zkontroluje a schválí.

Nastavení schválení

V této části nastavíte pravidlo na GitHubu, které vyžaduje, aby žádost o přijetí změn schválil alespoň jeden kontrolor, aby ho main bylo možné sloučit do větve. Potom ověříte, že pravidlo funguje, a to tak, že nasdílíte opravu do překlepové chyby, kterou Mara udělala dříve.

Přidání pravidla

  1. Na GitHubu přejděte do úložiště projektu Space Game .
  2. Vyberte kartu Nastavení v horní části stránky.
  3. V nabídce vlevo vyberte Větve.
  4. Ujistěte se, že je hlavní vybraná jako výchozí větev.
  5. Vyberte Přidat pravidlo ochrany větví.
  6. V části Vzor názvu větve zadejte hlavní.
  7. Zaškrtněte políčko Vyžadovat žádost o přijetí změn před sloučením.
  8. Zaškrtněte políčko Vyžadovat schválení.
  9. Ponechte hodnotu Povinné schvalování kontrol na 1.
  10. Vyberte Vytvořit.
  11. Vyberte volbu Uložit změny.

Poznámka:

V dolní části seznamu voleb je možnost Include Administrators (Zahrnout správce). Tato možnost vyžaduje, aby správci úložiště dodržovali pravidlo. Nenastavíte to, protože jste správcem úložiště a není k dispozici jiný revidujícím. V této lekci pro účely výuky zkontrolujete a schválíte vlastní žádosti o přijetí změn.

Odeslání opravy

V této části odešlete opravu překlepu na domovské stránce. Nezapomeňte, že slovo "oficiální" je nesprávně natypováno jako "oficial".

Screenshot of the Space Game website showing a typing error.

  1. V aplikaci Visual Studio Code přejděte do terminálu.

  2. Pokud chcete větev rezervovat main , spusťte git checkout:

    git checkout main

  3. Pokud chcete stáhnout nejnovější změny větve z GitHubu main , spusťte git pull:

    git pull origin main

    Uvidíte, že se aktualizují dva soubory:

    • README.md: Obsahuje kód Markdownu pro zobrazení odznáčku buildu.
    • Index.cshtml: Obsahuje aktualizovaný text domovské stránky, který obsahuje chybu při psaní.

  4. Pokud chcete chybu opravit, vytvořte a podívejte se na větev:

    git checkout -B bugfix/home-page-typo

  5. V Průzkumník souborů otevřete Index.cshtml.

  6. Vyhledejte chybu:

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

  7. Změňte řádek a opravte chybu:

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

  8. Soubor uložte.

  9. V terminálu proveďte fázi a potvrďte změnu:

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

    V praxi byste obvykle sestavili a spustili web místně a ověřili změnu. V této lekci z důvodu stručnosti tento krok přeskočíme.

  10. Nasdílejte větev do GitHubu.

    git push origin bugfix/home-page-typo

Otestování pravidla

  1. Na GitHubu bugfix/home-page-typo vyhledejte a vyberte větev.

    Screenshot of GitHub showing the recently pushed branch.

  2. Pokud chcete zahájit žádost o přijetí změn, vyberte Možnost Přispívat a pak Otevřít žádost o přijetí změn.

  3. Jako základní úložiště (base) nastavte svůj fork úložiště.

    Screenshot of GitHub confirming that the branch can be merged.

  4. Vyberte Vytvořit žádost o přijetí změn.

    Než změnu sloučíte, uvidíte, že je potřeba provést revizi člověka.

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

    V praxi byste přiřadili člena týmu ke kontrole změny. V této lekci můžete sloučit vlastní žádost o přijetí změn pro účely výuky.

  5. Zaškrtněte políčko Sloučit bez čekání na splnění požadavků (obejití ochrany větví) a pak vyberte Sloučit žádost o přijetí změn.

  6. Vyberte Potvrdit sloučení.

    Vaše změna je teď sloučená.

  7. Pokud chcete větev odstranit bugfix/home-page-typo , vyberte Odstranit větev.