GitHub Web-Auslöser

Die GitHub-Web-Auslöser sind so konfiguriert, dass sie Ereignisse in einem GitHub Repository oder einer Organisation überwachen.

Übersicht

DieGitHub Web-Auslöser hören auf bestimmte Ereignisse in einer GitHub-Organisation oder einem Repository. Wenn die Ereignisse in der Organisation oder im Repository auftreten, initiiert der Auslöser den konfigurierten Automatisierungs-Workflow.

Authentifizierung

Die GitHub-Web-Auslöser verwenden Personal Access Tokens für die Nutzer-Authentifizierung und benötigen keine OAuth-Verbindung. Weitere Informationen zum Erstellen und Verwalten von Personal Access Tokens finden Sie im Abschnitt Personal Access Tokens verwalten. Der GitHub-Web-Auslöser unterstützt klassische und feinabgestimmte Zugriffstokens. Achten Sie darauf, dass die Personal Access Tokens gültig sind.

Sie können dieses Token im Credential Vault speichern. Weitere Informationen zum Speichern und Verwalten von Anmeldeinformationen finden Sie unter Anmeldedaten und lockers im Credential Vault.

Unterstützte Ereignisse

Die GitHub-Web-Auslöser unterstützen die folgenden Ereignisse sowohl auf Organisations- als auch auf Repository-Ebene:

Veranstaltungen Beschreibung
Erstellen Sie Wenn eine Datei, ein Zweig (Branch) oder ein Tag erstellt wird
Fork Wenn ein Repository geforkt wird.
Kommentar zum Problem (Issue) Wenn ein Kommentar zu einem Problem (Issue) oder einer Pull Request hinzugefügt wird.
Probleme (Issues) Wenn ein Problem auf Repository-Ebene erstellt wird.
Benennung Wenn ein Label zu einem Problem oder einer Pull Request hinzugefügt oder daraus entfernt wird.
Pull Request Wenn eine Pull Request in einem Zweig innerhalb des Repository erstellt wird.
Pull Request-Überprüfung Wenn Review-Kommentar zur Pull Request hinzugefügt werden.
Push Wenn es einen Push auf einen Repository-Zweig gibt.
Star Wenn ein Repository mit einem Stern markiert wird
Ansehen Wenn die Beobachtungsoption für bestimmte Ereignisse innerhalb des Repository aktiviert ist.

Voraussetzungen

Achten Sie darauf, dass die folgenden Voraussetzungen erfüllt sind:

  • Eine Bot Creator- oder Citizen Developer-Lizenz.
  • Berechtigungen Meine Bots anzeigen und EREIGNISAUSLÖSER.
  • Einchecken- und Auschecken-Berechtigung für die Ordner, in denen sich die Automatisierung befindet.
  • Ein aktives GitHub Personal Access Token.

Einstellungen

Die folgenden Einstellungen sind für GitHub Web-Auslöser verfügbar:

Screenshot des Web-Auslösers der GitHub-Organisation

Screenshot der Web-Auslöser-Einstellungen für das GitHub-Repository

Ereignis überwachen
Wählen Sie ein oder mehrere Ereignisse aus, die der Auslöser überwachen muss.
Name der Organisation
Geben Sie den Organisationsnamen für den GitHub ein. Dieses Feld gilt nur für den GitHub-Organisation-Webauslöser.
Name des Repository
Geben Sie den Repository-Namen innerhalb der GitHub-Organisation ein. Dieses Feld gilt nur für den Web-Auslöser des GitHub-Repository.
Nutzerprofil
Geben Sie das GitHub-Nutzerprofil ein. Dieses Feld ist nur für den Web-Auslöser des GitHub-Repository anwendbar
Wählen Sie einen Authentifizierungstyp
Personal Access Token ist der Standardauthentifizierungstyp. Sie können entweder die Personal Access Tokens, die im Credential Vault gespeichert sind, mit der Option Auswählen Anmeldeinformation auswählen oder die Personal Access Tokens direkt in der Option Unsichere Zeichenfolge eingeben.
Antwort (optional)
Verwenden Sie die Option Antwort, um die Auslöser-Antwortdaten in einer Datensatz-Variable zu speichern. Sie können entweder eine neue Variable erstellen oder eine vorhandene Variable auswählen, um diese Antwortdaten zu speichern. Die Auslöser-Antwortdaten erfassen die Informationen aus dem GitHub-Webhook-API-Payload-Antwortkörper im Format von Schlüssel-Wert-Paaren. Verwenden Sie den Schlüssel als Namen in der Datensatz-Variable, sodass diese Daten als Eingaben für andere Aktionen innerhalb der Automatisierung dienen können.
Die GitHub-Web-Auslöser parsen die Webhook-Schlüssel-Wert-Paar-Nutzlast mit einer Punkt-(.)-Notation. Sie müssen das gleiche Format verwenden, um den Ausdruck für die Datensatz-Variable zu erstellen. Beispielsweise müssen Sie, um die repository id als Ausdruck zu verwenden, repository.id als Schlüssel eingeben. Weitere Informationen zur GitHub-Webhook-Payload-Dokumentation finden Sie unter GitHub webook events and payload.
Sobald der Bot fertig ausgeführt ist, protokolliert der Audit log die Auslösedaten der Antwort in einem Bot-Lauf durch das Auslöseereignis.