Hoe een review eruitziet
Hoe heyGRC bevindingen plaatst op een pull request: neutrale Checks-status, inline opmerkingen, één vaste samenvatting en /heygrc op aanvraag.
heyGRC is een compliance-reviewer, geen merge-blokkade standaard. Bij elke reviewronde koppelt het bevindingen aan de frameworks en bedrijfscontext die je hebt geconfigureerd.
Wat er op de pull request verschijnt
-
Checks-status Een GitHub-checkrun voor heyGRC. Standaard is deze neutraal (of succesvol bij geen bevindingen): het informeert; het blokkeert de PR niet om te mergen. Je kunt het verplicht maken in branch protection als je een blokkade wilt.
-
Inline opmerkingen Bevindingen op de relevante regels: control-ID / redenering waar een wijziging een verplichting raakt. Inline threads zijn oplosbare gesprekken (zie Blokkeert heyGRC merges?).
-
Eén samenvatting per PR (vast) heyGRC houdt één samenvatting bij voor de pull request en werkt deze in plaats bij naarmate je pusht. Het stapelt geen nieuwe volledige samenvatting bij elke commit. Een nieuwe reviewmelding wordt alleen geplaatst als er nieuwe bevindingen op Medium of hoger zijn. Lagere bevindingen verschijnen in de samenvatting. Herhalingen met niets nieuws op Medium of hoger blijven stil in de conversatie. Een
/heygrc-vermelding die niets nieuws vindt, kan voltooiing bevestigen met een reactie op je opmerking.
Wanneer reviews worden uitgevoerd
De reviewfrequentie wordt ingesteld in de console (organisatie-standaard, optionele per-repo overschrijving):
| Modus | Gedrag |
|---|---|
auto | Review wanneer een PR wordt geopend, heropend of gepusht naar |
auto_once | Review bij openen/heropenen alleen (niet bij elke push) |
mention_only | Stil totdat iemand /heygrc plaatst |
Standaard is auto. Teams die al een luidruchtige code-reviewbot gebruiken, beginnen vaak met auto_once of mention_only.
Op aanvraag: /heygrc
Plaats een opmerking /heygrc op een PR om een review te activeren. Je moet een Eigenaar, Lid of Medewerker van de repo zijn, zodat een toevallige commentator je reviews niet kan verbruiken.
Grote pull requests
heyGRC slaat een pull request niet over omdat deze te groot is. Bij een zeer grote PR beoordeelt het eerst de meest compliance-relevante bestanden en noemt de bestanden die niet zijn beoordeeld. Lockfiles, gegenereerde bestanden en vendored bestanden worden eerst uitgesloten. Orgs die EU inference inschakelen, gebruiken een kleiner reviewbudget, waardoor bij enorme diffs meer bestanden onbeoordeeld kunnen blijven.
Gerelateerd
- Opzetten met je agent (modi + installatie)
- Gebruiken met je code-reviewer
- Blokkeert heyGRC merges?