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
-
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ę.
-
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?).
-
Jedno podsumowanie na PR (przyklejone) heyGRC utrzymuje jedno podsumowanie dla pull request i edytuje je w miejscu podczas pushowania. Nie dodaje nowego pełnego podsumowania przy każdym commicie. Nowe powiadomienie o recenzji jest publikowane tylko wtedy, gdy pojawiają się nowe znaleziska na poziomie Medium lub wyższym. Znaleziska o niższym poziomie pojawiają się w podsumowaniu. Ponowne uruchomienia bez nowych znalezisk na poziomie Medium lub wyższym 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):
| Tryb | Zachowanie |
|---|---|
auto | Recenzja przy otwarciu, ponownym otwarciu lub pushowaniu do PR |
auto_once | Recenzja tylko przy otwarciu/ponownym otwarciu (nie przy każdym pushu) |
mention_only | Cicho 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
heyGRC nie pomija pull requesta ze względu na zbyt duży rozmiar. W przypadku bardzo dużego PR recenzuje najpierw najbardziej istotne dla zgodności pliki i wymienia pliki, których nie zrecenzował. Pliki lock, wygenerowane i zależności zewnętrzne są wyłączane w pierwszej kolejności. Organizacje, które włączą inferencję EU, korzystają z mniejszego budżetu recenzji, więc w przypadku ogromnych diffów więcej plików może pozostać nierozpatrzonych.
Powiązane
- Konfiguracja z agentem (tryby + instalacja)
- Użycie z recenzentem kodu
- Czy heyGRC blokuje merge?