Informationen zu Statuschecks

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 zu einem Branch auf der Branch-Seite deines Repositorys oder in der Liste der Pull Requests von deinem Repository sehen.

Wenn Statusprüfungen für ein Repository erforderlich sind, müssen sie bestanden werden, bevor Ihr Branch in den geschützten Branch zusammengeführt werden kann. Weitere Informationen finden Sie unter Informationen zu geschützten Branches.

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.
  

Organisationsinhaber*innen und Benutzende mit Push-Zugriff auf ein Repository können mit der API von GitHub Prüfungen und Statuse erstellen. Weitere Informationen findest du unter REST-API-Endpunkte für Prüfungen und REST-API-Endpunkte für Commit-Status.

Prüfungen

Pull-Requests verfügen über eine Registerkarte "Prüfungen", auf der Sie detaillierte Build-Ausgaben der Prüfungen anzeigen und fehlgeschlagene Prüfungen erneut ausführen können.

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 Commit-Nachricht 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, geben Sie Ihre Commit-Nachricht und eine kurze, aussagekräftige Beschreibung Ihrer Ä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>.

Prüfe 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).	Nein
expected	Die Überprüfungsausführung wartet darauf, dass ein Status gemeldet wird.	Ja
failure	Der Prüflauf ist fehlgeschlagen.	Nein
in_progress	Die Überprüfung wird ausgeführt.	Nein
pending	Der Check-Run steht an der Spitze der Warteschlange, aber das Gruppen-basierte Limit für Parallelität wurde erreicht.	Ja
queued	Die Überprüfungsausführung wurde in die Warteschlange gestellt.	Nein
requested	Die Überprüfungsausführung wurde erstellt, aber nicht in die Warteschlange verschoben.	Ja
startup_failure	Die Prüfsuite ist beim Start fehlgeschlagen. Dieser Status gilt nicht für Prüfungsdurchläufe.	Ja
waiting	Der Prüflauf wartet darauf, dass eine Bereitstellungsschutzregel erfüllt wird.	Ja

Zusammenfassung	Beschreibung
action_required	Die Überprüfungsausführung hat nach ihrer Beendigung die erforderlichen Aktionen bereitgestellt. Weitere Informationen finden Sie unter Verwenden der REST-API zur Interaktion mit Überprüfungen.
cancelled	Der Prüflauf wurde abgebrochen, bevor er abgeschlossen wurde.
failure	Der Prüflauf ist fehlgeschlagen.
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	Der Prüflauf wurde durch GitHub als veraltet gekennzeichnet, da er zu lange dauerte.
success	Die Überprüfung wurde erfolgreich ausgeführt.
timed_out	Die Überprüfungsausführung hat ein Timeout erreicht.

Aufbewahrung von Schecks

Websiteadministrator*innen können die Aufbewahrungsrichtlinie für Überprüfungsdaten für Ihre GitHub Enterprise Server-Instance festlegen. Weitere Informationen finden Sie unter Konfigurieren von Anwendungen.

Um einen Pull Request mit Überprüfungen zusammenzuführen, die sowohl erforderlich als auch archiviert sind, musst du die Überprüfungen erneut ausführen.