heyGRC Docs

Como é uma revisão

Como o heyGRC publica achados em um pull request: status neutro de Checks, comentários inline, um resumo fixo e /heygrc sob demanda.

heyGRC é um revisor de conformidade, não uma barreira de merge por padrão. Em cada passagem de revisão, ele fundamenta os achados nos frameworks e no contexto da empresa que você configurou.

O que aparece no pull request

  1. Status de Checks Uma execução de check do GitHub para o heyGRC. Por padrão, ele é neutro (ou sucesso quando limpo): informa; não falha o PR para bloquear o merge. Você pode torná-lo obrigatório na proteção de branch se quiser uma barreira.

  2. Comentários inline Achados nas linhas que importam: ID do controle / raciocínio onde uma alteração afeta uma obrigação. Tópicos inline são conversas resolvíveis (veja O heyGRC bloqueia merges?).

  3. Um resumo por PR (fixo) O heyGRC mantém um único resumo para o pull request e o atualiza no mesmo lugar conforme você faz push. Ele não empilha um novo resumo completo a cada commit. Quando há achados novos genuínos, você ainda recebe um sinal de revisão curto; reexecuções inalteradas permanecem silenciosas na conversa. Uma menção /heygrc que não encontra nada novo pode confirmar a conclusão com uma reação no seu comentário.

Quando as revisões são executadas

A cadência de revisão é definida no console (padrão da organização, opcional por repositório):

ModoComportamento
autoRevisa quando um PR é aberto, reaberto ou recebe push
auto_onceRevisa apenas na abertura/reabertura (não a cada push)
mention_onlySilencioso até que alguém comente /heygrc

O padrão é auto. Equipes que já utilizam um bot de revisão de código barulhento geralmente começam com auto_once ou mention_only.

Sob demanda: /heygrc

Comente /heygrc em um PR para acionar uma revisão. Você deve ser um Proprietário, Membro ou Colaborador no repositório para que um comentarista ocasional não consuma suas revisões.

Pull requests grandes

PRs muito grandes podem ser revisados apenas parcialmente ou marcados como parciais / ignorados com um check neutro claro para que o worker permaneça seguro. Prefira PRs menores quando precisar de cobertura completa.

Relacionados

On this page