Statuschecks basieren auf externen Prozessen, beispielsweise Builds mit fortlaufender Integration, die bei jedem Push an ein Repository ausgeführt werden. Du kannst die Zustände ausstehend, übergeben oder fehlerhaft der Statusüberprüfungen neben einzelnen Commits in deinem Pull Request anzeigen.
Personen mit Schreibberechtigungen für ein Repository können den Zustand für Statusprüfungen im Repository festlegen.
Du kannst den Gesamtzustand des letzten Commits an einen Branch auf der Branch-Seite deines Repositorys oder in der Liste der Pull Requests deines Repositorys sehen.
Wenn Statusprüfungen für ein Repository erforderlich sind, müssen die erforderlichen Statusprüfungen bestanden werden, bevor Du Deinen Branch mit der geschützten Branch zusammenführen kannst. Weitere Informationen finden Sie unter Informationen zu geschützten Branches.
Note
Der Status eines übersprungenen Auftrags wird als „Success“ angezeigt. Die Zusammenführung eines Pull Requests wird dadurch nicht verhindert, selbst wenn es sich um eine erforderliche Überprüfung handelt.
Arten von Statuschecks auf GitHub
Es gibt zwei Arten von Statuschecks auf GitHub:
- Prüfungen
- Commitstatus
Überprüfungen unterscheiden sich von Commit-Status insofern, als sie Zeilenanmerkungen und detailliertere Meldungen enthalten und nur für die Verwendung mit GitHub Apps verfügbar sind.
Note
GitHub Actions generiert Überprüfungen, wenn Workflows ausgeführt werden, jedoch keine Commitstatus.
Organisationsinhabende und benutzende Personen mit Push-Zugriff auf ein Repository können mit der API von GitHub Überprüfungen und Commitstatus erstellen. Weitere Informationen findest du unter REST-API-Endpunkte für Prüfungen und REST-API-Endpunkte für Commitstatus.
Prüfungen
Wenn Überprüfungen in einem Repository eingerichtet sind, enthalten Pull Requests einen Überprüfungen-Tab, auf dem Ihnen die Buildausgabe aus Überprüfungen und Wiederholungen im Detail angezeigt wird und Sie fehlerhafte Überprüfungen erneut ausführen können.
Note
Die Registerkarte Checks wird für Pull Requests nur ausgefüllt, wenn du für das Repository Überprüfungen einrichtest, keine Commitstatus.
Wenn eine Überprüfung aufgrund einer bestimmten Zeile in einem Commit nicht bestanden wird, siehst du Einzelheiten zum Fehler, zur Warnung oder zum Hinweis neben dem entsprechenden Code auf der Registerkarte Dateien des Pull Requests.
Du kannst zwischen den Überprüfungszusammenfassungen für verschiedene Commits in einem Pull Request wechseln, indem du das Dropdownmenü „Commit“ auf der Registerkarte Überprüfungen verwendest.
Prüfungen für einzelne Commits überspringen und anfordern
Wenn ein Repository so konfiguriert ist, dass es automatisch Prüfungen für Pushes anfordert, kannst du die Prüfungen für einen einzelnen Commit überspringen, den du überträgst. Wenn ein Repository nicht so konfiguriert ist, dass es automatisch Überprüfungen für Pushes anfordert, kannst du die Überprüfungen für einen einzelnen Commit anfordern, den du pushst. Weitere Informationen zu diesen Einstellungen findest du unter REST-API-Endpunkte für Prüfsuiten.
Du kannst Workflowausführungen überspringen, die durch die Ereignisse push und pull_request ausgelöst werden, indem du einen Befehl in deine Commitnachricht einfügst. Weitere Informationen findest du unter Überspringen von Workflowausführungen.
Alternativ kannst du eine der folgenden Trailerzeilen am Ende deiner Commitnachricht hinzufügen, um alle Überprüfungen für deinen Commit zu überspringen bzw. anzufordern.
-
Um Überprüfungen für einen Commit zu überspringen, gib deine Commitmitteilung und eine kurze, aussagekräftige Beschreibung deiner Änderungen ein. Füge nach der Commitbeschreibung vor dem schließenden Anführungszeichen zwei leere Zeilen hinzu, gefolgt von
skip-checks: true:$ git commit -m "Update README > > skip-checks: true" -
Um Überprüfungen für einen Commit anzufordern, gib deine Commitmitteilung und eine kurze, aussagekräftige Beschreibung deiner Änderungen ein. Füge nach der Commitbeschreibung vor dem schließenden Anführungszeichen zwei leere Zeilen hinzu, gefolgt von
request-checks: true:$ git commit -m "Refactor usability tests > > request-checks: true"
Standardmäßig entfernt Git automatisch aufeinander folgende Zeilenumbrüche. Wenn Sie die Commit-Mitteilung genau so belassen möchten, wie Sie sie eingegeben haben, verwenden Sie die --cleanup=verbatim-Option für Ihren Commit. Weitere Informationen findest du in der Git-Dokumentation unter --cleanup=<mode>.
Überprüfen von Status und Schlussfolgerungen
Überprüfungen können viele verschiedene Status aufweisen. Status beschreiben den Status einer Überprüfung, von dem Zeitpunkt, ab der sie erstellt wird, bis zu dem Zeitpunkt, zu dem sie abgeschlossen ist. Einige Status können nicht manuell festgelegt werden und sind für GitHub Actions reserviert. Wenn eine Überprüfung den Status completed aufweist, hat sie eine Schlussfolgerung. Die Schlussfolgerung beschreibt das Ergebnis der Überprüfung. Alle möglichen Überprüfungsstatus und Schlussfolgerungen sind unten aufgeführt.
| Status | Beschreibung | Nur GitHub Actions? |
|---|---|---|
completed | Die Überprüfung ist abgeschlossen und hat eine Schlussfolgerung (siehe unten). | No |
expected | Die Überprüfungsausführung wartet darauf, dass ein Status gemeldet wird. | Ja |
failure | Fehler bei der Ausführung der Überprüfung. | No |
in_progress | Die Überprüfung wird ausgeführt. | No |
pending | Die Überprüfungsausführung befindet sich am Anfang der Warteschlange, aber das gruppenbasierte Parallelitätslimit wurde erreicht. | Ja |
queued | Die Überprüfungsausführung wurde in die Warteschlange gestellt. | No |
requested | Die Überprüfungsausführung wurde erstellt, wurde jedoch nicht in die Warteschlange gestellt. | Ja |
startup_failure | Fehler bei der Überprüfungssammlung beim Start. Dieser Status gilt nicht für die Ausführung der Überprüfung. | Ja |
waiting | Die Überprüfungsausführung wartet darauf, dass eine Bereitstellungsschutzregel erfüllt ist. | Ja |
| Zusammenfassung | Beschreibung |
|---|---|
action_required | Die Überprüfung hat nach Abschluss erforderliche Aktionen bereitgestellt. Weitere Informationen finden Sie unter Verwenden der REST-API zur Interaktion mit Überprüfungen. |
cancelled | Die Überprüfungsausführung wurde abgebrochen, bevor sie abgeschlossen wurde. |
failure | Fehler bei der Ausführung der Überprüfung. |
neutral | Die Überprüfung wurde mit einem neutralen Ergebnis abgeschlossen. Dies wird als Erfolg für abhängige Überprüfungen in GitHub Actions behandelt. |
skipped | Die Überprüfungsausführung wurde übersprungen. Dies wird als Erfolg für abhängige Überprüfungen in GitHub Actions behandelt. |
stale | Die Überprüfungsausführung wurde durch GitHub gekennzeichnet, da sie zu lange dauerte. |
success | Die Überprüfung wurde erfolgreich ausgeführt. |
timed_out | Die Überprüfung hat ein Timeout erreicht. |
Aufbewahrung von Überprüfungen
GitHub speichert Überprüfungsdaten 400 Tage lang. Nach 400 Tagen werden die Daten archiviert. 10 Tage nach der Archivierung werden die Daten endgültig gelöscht.
Um einen Pull Request mit Überprüfungen zusammenzuführen, die sowohl erforderlich als auch archiviert sind, musst du die Überprüfungen erneut ausführen.