heyGRC Docs

Jak wygląda recenzja

Jak heyGRC publikuje wyniki w pull request: neutralny status Checks, komentarze w linii, jedno przyklejone podsumowanie i /heygrc na żądanie.

heyGRC to recenzent zgodności, a nie domyślna blokada merge. Przy każdym przejściu recenzji osadza wyniki w ramach i kontekście firmy, które skonfigurowałeś.

Co pojawia się w pull request

  1. Status Checks Uruchomienie checka GitHub dla heyGRC. Domyślnie jest neutralny (lub sukces, gdy jest czysty): informuje, nie blokuje merge PR. Możesz uczynić go wymaganym w ochronie gałęzi, jeśli chcesz blokadę.

  2. Komentarze w linii Wyniki dotyczące istotnych linii: ID kontroli / uzasadnienie, gdy zmiana dotyczy zobowiązania. Wątki w linii to rozwiązywalne konwersacje (zobacz Czy heyGRC blokuje merge?).

  3. Jedno podsumowanie na PR (przyklejone) heyGRC utrzymuje jedno podsumowanie dla pull request i aktualizuje je w miejscu podczas pushowania. Nie dodaje nowego pełnego podsumowania przy każdym commicie. Gdy pojawiają się nowe wyniki, nadal otrzymujesz krótki sygnał recenzji; niezmienione ponowne uruchomienia pozostają ciche w konwersacji. Wzmianka /heygrc, która nie znajdzie nic nowego, może potwierdzić zakończenie reakcją na twój komentarz.

Kiedy uruchamiają się recenzje

Częstotliwość recenzji ustawiana jest w konsoli (domyślna dla organizacji, opcjonalne nadpisanie dla repozytorium):

TrybZachowanie
autoRecenzja przy otwarciu, ponownym otwarciu lub pushowaniu do PR
auto_onceRecenzja tylko przy otwarciu/ponownym otwarciu (nie przy każdym pushu)
mention_onlyCicho do momentu, gdy ktoś skomentuje /heygrc

Domyślnie jest auto. Zespoły, które już korzystają z hałaśliwego bota do recenzji kodu, często zaczynają od auto_once lub mention_only.

Na żądanie: /heygrc

Skomentuj /heygrc w PR, aby uruchomić recenzję. Musisz być Właścicielem, Członkiem lub Współpracownikiem repozytorium, aby przypadkowy komentator nie zużył twoich recenzji.

Duże pull requesty

Bardzo duże PR-y mogą być recenzowane tylko częściowo lub oznaczone jako częściowe / pominięte z wyraźnym neutralnym checkiem, aby worker pozostał bezpieczny. Preferuj mniejsze PR-y, gdy potrzebujesz pełnego pokrycia.

Powiązane

On this page