heyGRC Docs

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

  1. 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.

  2. 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?).

  3. 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. Als er echt nieuwe bevindingen zijn, krijg je nog steeds een kort reviewsignaal; ongewijzigde herhalingen 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):

ModusGedrag
autoReview wanneer een PR wordt geopend, heropend of gepusht naar
auto_onceReview bij openen/heropenen alleen (niet bij elke push)
mention_onlyStil 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

Zeer grote PR's kunnen slechts gedeeltelijk worden beoordeeld of worden gemarkeerd als gedeeltelijk/overgeslagen met een duidelijke neutrale check, zodat de worker veilig blijft. Geef de voorkeur aan kleinere PR's als je volledige dekking nodig hebt.

Gerelateerd

On this page