Ćwiczenie — dodawanie reguły w celu wymagania przeglądu

  • 9 min

W tej lekcji skonfigurujesz regułę w usłudze GitHub, która wymaga od recenzenta zatwierdzenia zmian przed scaleniem ich z gałęzią main . Dodatkowo naprawisz również błąd wpisywania na stronie głównej witryny Space Game .

Obecnie zespół umożliwia scalenie kodu z gałęzią main wszystkim użytkownikom, którzy wyślą żądanie ściągnięcia. Ponieważ przegląd nie jest wymagany, możliwe jest, aby niepoprawny lub niestabilny kod wkradł się.

Andy decyduje, że chce dodać dodatkową osobę kontrolującą żądania ściągnięcia. Chce skonfigurować usługę GitHub, aby wymagać od kogoś innego niż autor żądania ściągnięcia, aby przejrzeć kod przed scaleniem. Przekonajmy się, jak to zrobić.

Andy wyrusza na poszukiwanie Mary i znajduje ją przy biurku, kiwającą głową w takt muzyki ze słuchawek.

Andy: Mara, mam znaczenie, aby porozmawiać z tobą o czymś.

Mara patrzy na rozmówcę.

Mara: Z czym mogę ci pomóc?

Andy: Kilka małych błędów sprawia, że przez kompilację. Właśnie dzisiaj na stronie głównej pojawił się błąd wpisywania. Amita spędza nad tym zbyt wiele czasu. Musimy usunąć te błędy, zanim trafią do gałęzi main. Potrzebujemy dodatkowej osoby, która będzie kontrolować kod przed zatwierdzeniem żądania ściągnięcia.

Mara: Mogę to skonfigurować. W usłudze GitHub istnieje sposób, aby upewnić się, że żadne żądanie ściągnięcia nie zostało scalone przed sprawdzeniem i zatwierdzeniem przez kogoś innego.

Konfigurowanie zatwierdzeń

W tej sekcji skonfigurujesz regułę w usłudze GitHub, która wymaga co najmniej jednego recenzenta zatwierdzenia żądania ściągnięcia przed scaleniem go z gałęzią main . Następnie sprawdzisz, czy reguła działa, wypychając poprawkę do błędu wpisywania wprowadzonego wcześniej przez Marę.

Dodawanie reguły

  1. W usłudze GitHub przejdź do repozytorium projektu Space Game .
  2. Wybierz kartę Ustawienia w górnej części strony.
  3. W menu po lewej stronie wybierz pozycję Gałęzie.
  4. Upewnij się, że jako gałąź domyślna została wybrana główna.
  5. Wybierz pozycję Dodaj regułę ochrony gałęzi.
  6. W obszarze Wzorzec nazwy gałęzi wprowadź wartość main.
  7. Zaznacz pole wyboru Wymagaj żądania ściągnięcia przed scaleniem.
  8. Zaznacz pole wyboru Wymagaj zatwierdzeń .
  9. Zachowaj wartość Wymagane zatwierdzenia przeglądów na 1.
  10. Wybierz pozycję Utwórz.
  11. Wybierz Zapisz zmiany.

Uwaga

W dolnej części listy widoczna jest opcja Include Administrators (Uwzględnij administratorów). Ta opcja wymaga, aby administratorzy repozytorium postępowali zgodnie z regułą. Nie ustawiasz tego ustawienia, ponieważ jesteś administratorem repozytorium i nie ma innego recenzenta. W tej lekcji na potrzeby uczenia się przeglądasz i zatwierdzasz własne żądania ściągnięcia.

Przesyłanie poprawki

W tej sekcji prześlesz poprawkę do błędu wpisywania na stronie głównej. Pamiętaj, że słowo "official" jest błędnie wytypowane jako "oficial".

Screenshot of the Space Game website showing a typing error.

  1. W programie Visual Studio Code przejdź do terminalu.

  2. Aby wyewidencjonować main gałąź, uruchom polecenie git checkout:

    git checkout main

  3. Aby ściągnąć najnowsze zmiany w main gałęzi z usługi GitHub, uruchom polecenie git pull:

    git pull origin main

    Widać, że dwa pliki są aktualizowane:

    • README.md: zawiera kod markdown umożliwiający wyświetlenie wskaźnika kompilacji.
    • Index.cshtml: zawiera zaktualizowany tekst strony głównej, który zawiera błąd wpisywania.

  4. Aby naprawić błąd, utwórz i wyewidencjonuj gałąź:

    git checkout -B bugfix/home-page-typo

  5. W Eksplorator plików otwórz plik Index.cshtml.

  6. Znajdź błąd:

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

  7. Zmień wiersz, aby poprawić błąd:

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

  8. Zapisz plik.

  9. W terminalu przygotuj i zatwierdź zmianę:

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

    W praktyce zwykle kompilujesz i uruchamiasz lokację lokalnie, aby zweryfikować zmianę. W tej lekcji ze względu na zwięzłość pomińmy ten krok.

  10. Wypchnij gałąź do repozytorium usługi GitHub.

    git push origin bugfix/home-page-typo

Testowanie reguły

  1. W usłudze GitHub znajdź i wybierz bugfix/home-page-typo gałąź.

    Screenshot of GitHub showing the recently pushed branch.

  2. Aby rozpocząć żądanie ściągnięcia, wybierz pozycję Współtworzenie , a następnie otwórz żądanie ściągnięcia.

  3. Ustaw rozwidlone repozytorium jako podstawowe.

    Screenshot of GitHub confirming that the branch can be merged.

  4. Wybierz pozycję Utwórz żądanie ściągnięcia.

    Aby można było scalić zmianę, można zobaczyć, że wymagana jest recenzja przez człowieka.

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

    W praktyce należy przypisać członka zespołu, aby przejrzeć zmiany. W tej lekcji możesz scalić własne żądanie ściągnięcia na potrzeby nauki.

  5. Zaznacz pole wyboru Scal bez oczekiwania na spełnienie wymagań (obejście ochrony gałęzi), a następnie wybierz pozycję Scal żądanie ściągnięcia.

  6. Wybierz pozycję Potwierdź scalanie.

    Zmiana zostanie scalona.

  7. Aby usunąć bugfix/home-page-typo gałąź, wybierz pozycję Usuń gałąź.