Der Check HeyDeer Review
HeyDeer meldet jede Prüfung in einem GitHub-Check namens HeyDeer Review. Erfahre, was sein Ergebnis bedeutet und wie er das Mergen blockieren kann.
Was der Check anzeigt
Der Check erscheint an dem Commit, den HeyDeer geprüft hat. Er zeigt den Fortschritt der Prüfung und wird dann mit einem der unten aufgeführten Abschlussstatus beendet. Sein Link Details öffnet die Prüfung in HeyDeer.
Während Autopilot an einem PR arbeitet, bleibt der Check in Bearbeitung, bis Autopilot stoppt und HeyDeer seine Prüfung veröffentlicht.
Standardmäßig lassen Befunde den Check nicht fehlschlagen. Um das Mergen zu blockieren, bis sie behoben oder abgelehnt sind, aktiviere Check bei gefundenen Problemen fehlschlagen lassen und lege den Check als erforderlich fest.
Die Zusammenfassung beginnt mit der Anzahl der Befunde, der offenen früheren Bedenken und der fehlgeschlagenen Repository-Prüfungen. Bei einer Folgeprüfung gibt sie an, ob HeyDeer nur die Änderungen seit der vorherigen Prüfung geprüft hat.
Darunter zeigt der Check die vollständige Prüfung: Hinweise zur Prüfung, alle Befunde, in der Diskussion abgelehnte Bedenken und die Genehmigungsentscheidung, wenn die automatische Genehmigung aktiviert ist. Siehe Eine Prüfung lesen.
Den Check vor dem Mergen verlangen
- Lass HeyDeer mindestens einen Pull Request im Repository prüfen, damit der Check existiert.
- Öffne in GitHub die Branch-Schutzregel oder das Ruleset für deinen Basis-Branch und aktiviere erforderliche Status-Checks.
- Füge HeyDeer Review hinzu und wähle HeyDeer als Quelle aus.
- Aktiviere in HeyDeer Check bei gefundenen Problemen fehlschlagen lassen unter Arbeitsbereichseinstellungen → Prüfregeln → Ergebnisse veröffentlichen oder in den Prüfregeln eines Repositorys.
GitHub wertet Success, Neutral und Skipped als bestanden und Failure, Action required, Timed out und Cancelled 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 einem Repository mit Nur manuell veröffentlicht HeyDeer keinen Check, bis dort die erste Prüfung stattfindet. Siehe Automatische Prüfungen.
Wenn kein Check erscheint, siehe Fehlerbehebung.
Check bei gefundenen Problemen fehlschlagen lassen
Diese Einstellung ist standardmäßig deaktiviert, sodass eine abgeschlossene Prüfung auch dann besteht, wenn sie Befunde meldet.
Ist sie aktiviert, schlägt der Check bei Befunden innerhalb des Feedback-Umfangs fehl, auch bei Befunden, die mit bestehenden Unterhaltungen verknüpft sind, sowie bei offenen oder unbestätigten früheren Bedenken. Bedenken, die jemand mit Schreibzugriff abgelehnt hat, zählen nicht. Siehe Frühere Bedenken.
Eine Prüfung mit Hinweisen zur Prüfung schlägt ebenfalls fehl. Einige Commits, die nicht automatisch geprüft wurden, zeigen Action required statt Skipped; siehe Abschlussstatus.
Abschlussstatus
| Abschlussstatus | Titel | Wann |
|---|---|---|
| Success | Prüfung abgeschlossen – keine Probleme gefunden / Prüfung mit Befunden abgeschlossen / Frühere Bedenken müssen bestätigt werden / Prüfung mit Hinweisen abgeschlossen | Die Prüfung ist vollständig, und nichts muss geklärt werden. Ist Check bei gefundenen Problemen fehlschlagen lassen deaktiviert, gilt das auch für Prüfungen mit Befunden oder früheren Bedenken. |
| Neutral | Prüfung unvollständig / Prüfung mit Befunden abgeschlossen / Prüfung erfordert Klärung | Unabhängig von der Einstellung muss eine Frage geklärt werden, oder die Prüfung enthält Hinweise zur Prüfung und Check bei gefundenen Problemen fehlschlagen lassen ist deaktiviert. |
| Failure | Die Prüfung hat Probleme gefunden, die bearbeitet werden müssen / Frühere Bedenken müssen bestätigt werden / Prüfung unvollständig / Prüfung konnte nicht ausgeführt werden / Prüfung fehlgeschlagen | Wenn Check bei gefundenen Problemen fehlschlagen lassen aktiviert ist: Befunde, frühere Bedenken oder Hinweise zur Prüfung. Unabhängig von der Einstellung: Eine Repository-Prüfung wurde nicht ausgeführt, ein früheres Bedenken wurde nicht erneut geprüft, oder HeyDeer konnte die Prüfung nicht starten oder abschließen. |
| Timed out | Zeitüberschreitung bei der Prüfung | Die Prüfung hat das Zeitlimit überschritten. |
| Cancelled | Prüfung abgebrochen / Prüfung überholt | Die Prüfung wurde abgebrochen, oder ihr Ergebnis gilt nicht mehr, weil sich der Basis-Branch geändert hat oder kein offener PR diesen Commit als neuesten Commit hat. |
| Skipped | Prüfung übersprungen / Keine prüfbaren Dateien | Deine Filter für automatische Prüfungen schließen den Pull Request aus (standardmäßig Entwürfe, PRs aus Forks und Abhängigkeitsupdates), oder jede geänderte Datei liegt außerhalb des Prüfumfangs. Der Check wird außerdem übersprungen, wenn HeyDeer eine automatische Prüfung stoppt, weil sich der PR geändert hat. |
| Skipped oder Action required | Prüfung übersprungen / Prüfung erforderlich | Wegen Nur manuell, Einmal pro PR, einer Pause für den PR oder der Höchstzahl automatischer Prüfungen pro PR wurde keine automatische Prüfung ausgeführt. Weitere mögliche Gründe: Dem Arbeitsbereich fehlen Credits, sein Nutzungslimit ist erreicht oder das Repository ist in einem anderen Arbeitsbereich mit kostenlosen Credits verknüpft. Ist Check bei gefundenen Problemen fehlschlagen lassen aktiviert, lautet der Status Action required und blockiert das Mergen. |
Wenn HeyDeer einen Commit nicht automatisch prüft, nennt der Titel den Grund, zum Beispiel, dass der Pull Request die Höchstzahl automatischer Prüfungen pro PR erreicht hat.
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. Siehe auch Fehlerbehebung.
Eine Prüfung über den Check anfordern
Re-run, Re-run all und die Schaltfläche Revision prüfen fordern jeweils eine Prüfung des Commits an, zu dem der Check gehört, so als hättest du @heydeer review kommentiert. Revision prüfen erscheint, wenn eine Prüfung der nächste Schritt ist. Siehe Befehle in PR-Kommentaren.
Wenn HeyDeer die Anfrage nicht annehmen kann, bleibt der Check unverändert. Kommentiere @heydeer review, um den Grund zu erfahren.
Merge-Queues
In einer Merge-Queue bestätigt der Check, dass jeder eingereihte Pull Request seine Prüfanforderungen erfüllt, ohne den kombinierten Code zu prüfen oder Credits zu verbrauchen. Deine CI sollte die Merge-Gruppe trotzdem testen.
Wenn sich mehrere offene PRs einen Commit teilen
Offene PRs mit demselben neuesten Commit teilen sich einen Check, der nur besteht, wenn die Prüfung jedes PRs das Mergen erlaubt. Seine Zusammenfassung verlinkt auf den vollständigen Bericht jedes PRs.
Ein gemeinsamer Check hat keine Schaltfläche „Revision prüfen“; fordere stattdessen eine Prüfung für den jeweiligen PR an.