Guardrail-Ledger-Dokumentation
Das Gate und Ausnahmen
Das Gate entscheidet, ob ein Pull Request besteht. Eine Ausnahme verhindert bis zu ihrem Ablauf, dass ein akzeptierter Befund das Gate fehlschlagen lässt.
Das Gate festlegen
Ein Owner oder Admin öffnet die Seite Gates und legt fest:
- Den niedrigsten Schweregrad, bei dem ein Pull Request fehlschlägt: critical, high, medium oder low. Neue Workspaces beginnen bei high.
- Die Engines, die für das Gate zählen. Jeder Scanner läuft weiterhin, und jeder Befund wird erfasst. Befunde einer Engine, die nicht auf der Liste steht, lassen das Gate nicht fehlschlagen.
- Das Contributor-Limit, gezählt als eindeutige Build-Auslöser über 30 Tage. Das Gate fügt einen fehlschlagenden Punkt hinzu, wenn mehr Personen als das Limit Builds ausgeführt haben.
Wählen Sie Save (Speichern). Das Ändern des Gates wird im Audit-Log festgehalten.
Das Ergebnis lesen
Jeder Lauf antwortet mit dem Gate-Ergebnis. Wenn das Gate blockiert, antwortet der Ingest-Aufruf mit Status 409, und der Schritt oder Job schlägt fehl, sofern Sie nicht failOnGate: false an der Task oder fail-on-gate: false an der Action setzen. Das Ergebnis wird außerdem in den Pull-Request-Kommentar und, auf GitHub, in die Job-Zusammenfassung geschrieben. Befunde bleiben unter Findings mit dem Repository und dem Pull Request, in dem sie gefunden wurden.
Ein Scan behebt nur die Befunde der Engines, die darin berichtet haben. Ein Befund, der nicht mehr erscheint, wird als behoben markiert.
Eine Ausnahme erfassen
- Ein Owner oder Admin öffnet die Seite Exceptions.
- Wählen Sie einen offenen Befund oder fügen Sie seinen Fingerprint ein.
- Wählen Sie den Verantwortlichen, ein Workspace-Mitglied, das nicht Sie selbst ist. Sie werden als Genehmiger erfasst.
- Schreiben Sie die Begründung und legen Sie das Ablaufdatum fest, höchstens 90 Tage ab heute.
- Wählen Sie Record exception (Ausnahme erfassen). Sie gilt sofort.
Ein ausgenommener Befund lässt das Gate nicht fehlschlagen. Nach dem Ablaufdatum zählt ihn der nächste Scan wieder für das Gate. Die Konsole hat keine Schaltfläche, um eine Ausnahme zu widerrufen.