Der Check HeyDeer Review
HeyDeer meldet jede Prüfung als GitHub-Check namens HeyDeer Review am geprüften Commit. Der Check enthält die Zusammenfassung und das vollständige Prüfergebnis, und Sie können ihn als Voraussetzung für das Mergen festlegen.
Was der Check anzeigt
Der Check zeigt den Fortschritt einer Prüfung und wird dann mit einem der unten aufgeführten Abschlussstatus beendet. Sein Details-Link öffnet die Prüfung in HeyDeer.
Die Zusammenfassung beginnt mit der Anzahl der Befunde, der ungelösten früheren Threads und der fehlgeschlagenen Repository-Prüfungen und gibt an, ob eine Folgeprüfung nur die Änderungen seit der vorherigen Prüfung von HeyDeer abgedeckt hat. Die Seite des Checks zeigt dann das vollständige Prüfergebnis: Warnungen, jedes Problem, in der Diskussion abgelehnte Bedenken und die Genehmigungsentscheidung, wenn „Automatische Genehmigung“ aktiviert ist. Siehe Eine Prüfung lesen.
Abschlussstatus
| Abschlussstatus | Titel | Wann |
|---|---|---|
| Erfolg | Review completed — no issues found / Review completed with findings | Keine Probleme, oder Probleme bei deaktiviertem „Prüfung bei gefundenen Problemen fehlschlagen lassen“. |
| Neutral | Review completed with warnings / Review completed with findings | Die Prüfung enthält eine Warnung, und die Einstellung ist deaktiviert. |
| Fehlschlag | Review found issues that need attention / Review incomplete | Probleme oder eine Warnung bei aktivierter Einstellung. „Review incomplete“ erscheint unabhängig von der Einstellung auch dann, wenn eine Repository-Prüfung oder ein früherer Befund nicht bewertet wurde. |
| Fehlschlag | Review could not run / Review failed | HeyDeer konnte die Prüfung nicht starten oder abschließen. Die Zusammenfassung nennt den Grund. |
| Zeitüberschreitung | Review timed out | Die Prüfung hat das Zeitlimit überschritten. |
| Abgebrochen | Review cancelled / Review superseded | Die Prüfung wurde abgebrochen, oder das Ergebnis gilt für einen älteren Commit oder Ziel-Branch. |
| Übersprungen | Review skipped / No reviewable files | Ihre „Filter für automatische Reviews“ schließen den Pull Request aus (standardmäßig Entwürfe), oder jede geänderte Datei liegt außerhalb des Prüfumfangs. |
| Übersprungen oder Aktion erforderlich | Review skipped / Review required | Der Commit wurde nicht automatisch geprüft, zum Beispiel bei „Nur manuell“, nachdem „Einmal pro PR“ seine Prüfung verbraucht hat, oder wenn keine Credits mehr vorhanden sind. Bei aktivierter Einstellung lautet der Status „Aktion erforderlich“. |
Wenn ein Commit nicht geprüft oder die Prüfung nicht abgeschlossen wurde, nennt die Zusammenfassung den nächsten Schritt, meist einen Kommentar mit @heydeer review.
Prüfung bei gefundenen Problemen fehlschlagen lassen
Diese Einstellung ist standardmäßig deaktiviert, sodass eine abgeschlossene Prüfung auch dann als bestanden gilt, wenn sie Probleme meldet. Aktivieren Sie sie unter „Ergebnisse veröffentlichen“; siehe Ergebnisse veröffentlichen.
Als Probleme gelten Befunde innerhalb des Feedback-Umfangs der Prüfung, auch solche, die bereits in der Diskussion angesprochen wurden, sowie noch offene frühere Threads von HeyDeer. Bedenken, die jemand mit Schreibzugriff abgelehnt hat, zählen nicht. Siehe Folgeprüfungen.
Den Check vor dem Mergen verlangen
- Lassen Sie HeyDeer mindestens einen Pull Request im Repository prüfen, damit der Check existiert.
- Öffnen Sie in GitHub die Branch-Schutzregel oder das Ruleset für Ihren Ziel-Branch und aktivieren Sie erforderliche Status-Checks.
- Fügen Sie HeyDeer Review hinzu und wählen Sie HeyDeer als Quelle aus.
- Aktivieren Sie „Prüfung bei gefundenen Problemen fehlschlagen lassen“. Andernfalls ist der Check auch dann erfolgreich, wenn eine Prüfung Probleme meldet.
GitHub wertet Erfolg, Neutral und Übersprungen als bestanden und Fehlschlag, Aktion erforderlich, Zeitüberschreitung und Abgebrochen als blockierend. Sobald HeyDeer in einem Repository Checks veröffentlicht, erhält jede Aktualisierung eines Pull Requests ein Check-Ergebnis, sodass ein erforderlicher Check nie endlos wartet. In einer Merge Queue bestätigt der Check, dass jeder Pull Request in der Warteschlange seine Prüfanforderungen erfüllt, ohne den kombinierten Code zu prüfen oder Credits zu verbrauchen; Ihre CI sollte die Merge Group weiterhin prüfen.
In einem Repository mit „Nur manuell“ veröffentlicht HeyDeer keinen Check, bis dort die erste Prüfung stattfindet. Siehe Automatische Reviews.
Eine Prüfung über den Check anfordern
„Re-run“, „Re-run all“ und die Schaltfläche „Review this revision“ wirken jeweils wie ein Kommentar @heydeer review der Person, die geklickt hat, für den Commit dieses Checks. „Review this revision“ erscheint, wenn eine Prüfung der nächste Schritt ist. Siehe Befehle in PR-Kommentaren.