heyGRC Docs

Come si presenta una revisione

Come heyGRC pubblica i risultati su una pull request: stato Checks neutrale, commenti inline, un riepilogo adesivo e /heygrc su richiesta.

heyGRC è un revisore di conformità, non un blocco di merge per impostazione predefinita. Ad ogni passaggio di revisione, contestualizza i risultati nei framework e nel contesto aziendale che hai configurato.

Cosa appare sulla pull request

  1. Stato Checks Una esecuzione di check di GitHub per heyGRC. Per impostazione predefinita è neutrale (o successo quando pulito): informa; non fa fallire la PR per bloccare il merge. Puoi renderlo obbligatorio nella protezione dei branch se desideri un blocco.

  2. Commenti inline Risultati sulle linee che contano: ID del controllo / ragionamento dove una modifica tocca un obbligo. I thread inline sono conversazioni risolvibili (vedi heyGRC blocca i merge?).

  3. Un riepilogo per PR (adesivo) heyGRC mantiene un singolo riepilogo per la pull request e lo aggiorna sul posto man mano che invii modifiche. Non aggiunge un nuovo riepilogo completo ad ogni commit. Quando ci sono nuovi risultati, ricevi comunque un breve segnale di revisione; le riesecuzioni invariate rimangono silenziose nella conversazione. Una menzione /heygrc che non trova nulla di nuovo può confermare il completamento con una reazione al tuo commento.

Quando vengono eseguite le revisioni

La cadenza delle revisioni è impostata nella console (predefinito per l'organizzazione, opzionale l'override per repo):

ModalitàComportamento
autoRevisione quando una PR viene aperta, riaperta o aggiornata con un push
auto_onceRevisione solo all'apertura/riapertura (non ad ogni push)
mention_onlySilenzioso fino a quando qualcuno commenta /heygrc

Il valore predefinito è auto. I team che già utilizzano un bot di revisione del codice rumoroso spesso iniziano con auto_once o mention_only.

Su richiesta: /heygrc

Commenta /heygrc su una PR per attivare una revisione. Devi essere un Owner, Member o Collaborator sul repository in modo che un commentatore occasionale non possa consumare le tue revisioni.

Pull request di grandi dimensioni

Le PR molto grandi possono essere revisionate solo in parte o contrassegnate come parziali / saltate con un check neutrale chiaro in modo che il worker rimanga al sicuro. Preferisci PR più piccole quando hai bisogno di una copertura completa.

Correlati

On this page