heyGRC Docs

Wie eine Überprüfung aussieht

Wie heyGRC Befunde in einem Pull Request veröffentlicht: neutraler Checks-Status, Inline-Kommentare, eine feste Zusammenfassung und /heygrc auf Anfrage.

heyGRC ist ein Compliance-Prüfer, kein standardmäßiges Merge-Gate. Bei jedem Prüfungsdurchlauf werden Befunde in den von Ihnen konfigurierten Frameworks und dem Unternehmenskontext verankert.

Was im Pull Request erscheint

  1. Checks-Status Ein GitHub-Check-Lauf für heyGRC. Standardmäßig ist er neutral (oder erfolgreich, wenn keine Probleme vorliegen): Er informiert, blockiert aber nicht das Merge des PR. Sie können ihn in den Branch-Schutzregeln als erforderlich festlegen, wenn Sie ein Gate wünschen.

  2. Inline-Kommentare Befunde zu den relevanten Zeilen: Kontroll-ID / Begründung, wo eine Änderung eine Verpflichtung betrifft. Inline-Threads sind auflösbare Gespräche (siehe Blockiert heyGRC Merges?).

  3. Eine Zusammenfassung pro PR (fest) heyGRC behält eine einzige Zusammenfassung für den Pull Request bei und aktualisiert sie direkt, während Sie pushen. Es wird nicht bei jedem Commit eine neue vollständige Zusammenfassung hinzugefügt. Wenn es tatsächlich neue Befunde gibt, erhalten Sie weiterhin ein kurzes Prüfungssignal; unveränderte Wiederholungen bleiben im Gespräch ruhig. Eine /heygrc-Erwähnung, die nichts Neues findet, kann den Abschluss mit einer Reaktion auf Ihren Kommentar bestätigen.

Wann Überprüfungen durchgeführt werden

Der Überprüfungsrhythmus wird in der Konsole festgelegt (Organisationsstandard, optionale Repository-Überschreibung):

ModusVerhalten
autoÜberprüfung, wenn ein PR geöffnet, wieder geöffnet oder gepusht wird
auto_onceÜberprüfung nur beim Öffnen/Wiederöffnen (nicht bei jedem Push)
mention_onlyStumm, bis jemand /heygrc kommentiert

Standardmäßig ist auto eingestellt. Teams, die bereits einen lärmenden Code-Review-Bot verwenden, beginnen oft mit auto_once oder mention_only.

Auf Anfrage: /heygrc

Kommentieren Sie /heygrc in einem PR, um eine Überprüfung auszulösen. Sie müssen Owner, Member oder Collaborator des Repositorys sein, damit ein zufälliger Kommentator Ihre Überprüfungen nicht verbrauchen kann.

Große Pull Requests

Sehr große PRs können nur teilweise überprüft oder als teilweise/übersprungen mit einem klaren neutralen Check markiert werden, damit der Worker sicher bleibt. Bevorzugen Sie kleinere PRs, wenn Sie vollständige Abdeckung benötigen.

Verwandte Themen

On this page