GitHub Spoke

Apps im Store anfordern

Besuchen Sie die ServiceNow Store-Website, um alle verfügbaren Apps anzuzeigen und Informationen zum Senden von Anforderungen an den Store zu erhalten. Kumulative Informationen zum Release für alle veröffentlichten Apps finden Sie in den Release-Hinweisen zum ServiceNow Store-Versionsverlauf.

IntegrationHub-Abonnement

Diese Spoke erfordert ein Integration Hub-Abonnement. Weitere Informationen finden Sie unter Gesetzliche Zeitpläne − IntegrationHub − Übersicht.

Spoke-Version

GitHub-Spoke v3.0.0 ist die neueste Version.

Unterstützte Versionen

Diese Spoke wurde für GitHub API-Version v3 erstellt, ist jedoch möglicherweise mit späteren Versionen kompatibel.

Spoke-Anforderungen

GitHub Account
Anwender mit Administrator-Anmeldeinformationen
Token zum Authentifizieren der Instanz ServiceNow .

Siehe GitHub Dokumentation Anweisungen zum Erstellen eines GitHub -Accounts und zum Generieren eines Tokens.

GitHub Webhooks-Modul

Bidirektionale Webhooks können so eingerichtet werden, dass sie über die erforderlichen Ereignisse benachrichtigt werden. Die Weiterleitungsrichtlinie definiert Bedingungen, die erfüllt sein müssen, um die App ServiceNow zu benachrichtigen. Diese Bedingungen basieren auf den Ereignissen in GitHub, über die Sie benachrichtigt werden möchten. Wenn die Bedingungen erfüllt sind, löst die Weiterleitungsrichtlinie den zugehörigen Subflow aus, der wiederum die Aufgaben GitHub automatisiert.

Die bidirektionalen Webhooks erfordern ein separates Setup und können unabhängig voneinander ohne Verwendung der Spoke-Aktionen verwendet werden. Standardmäßig ist die Anwendung GitHub Webhooks im GitHub-Spoke verfügbar und verfügt über die folgenden Module:

GitHub Webhook-Registrierungen
GitHub WebHook-Weiterleitungsrichtlinien

Verwenden Sie das Modul GitHub Webhook-Registrierungen, um ein Token zuzuweisen und den API-Pfad anzugeben. Sie müssen hier eine Rückruf-URL generieren und diese URL in GitHubangeben. Eine Standardweiterleitungsrichtlinie wird im Modul GitHub WebHook Routing Policies (WebHook-Routing-Richtlinien) bereitgestellt. Die Standardweiterleitungsrichtlinie unterstützt die folgenden GitHub -Felder:


Unterstützte Felder GitHub .
Aktion	Projektkartenersteller	Ref
Basisreferenz	Projektkartennotiz	Referenztyp
Commit-Kommentar	Vorheriger Hinweis der Projektkarte	Release-Assets
Commit-Kommentar erstellt um	Projektkarte aktualisiert um	Release-Autor
Commit-Kommentarpfad	Projektspalte erstellt um	Release-Text
Commit-Kommentar aktualisiert um	Name der Projektspalte	Release erstellt um
Commit-Kommentarbenutzer	Vorheriger Name der Projektspalte	Release-Entwurf
Push erzwingen	Projektspalte aktualisiert um	Release-Name
URL der GitHub-Instanz	Projekt erstellt um	Release veröffentlicht um
Problem zugewiesen an	Projektname	Release-Tag-Name
Problembeauftragte	Vorheriger Textkörper des Projekts	Releaseziel-Commits
Problemtext	Vorheriger Name des Projekts	Repository archiviert
Problem geschlossen um	Projektstatus	Repository erstellt um
Problemkommentar	Projekt aktualisiert um	Repository-Beschreibung
Anzahl der Problemkommentare	Abrufanforderung zugewiesen an	Repository inaktiv
Problemkommentar erstellt um	Beauftragte für Abrufanforderung	Vollständiger Repository-Name
Problemkommentar aktualisiert um	Abrufanforderungstext	Repository weist Probleme auf
Problem erstellt um	Abrufanforderung geschlossen um	Repository enthält Projekte
Problem mit der Bezeichnung „Zu“.	Anzahl der Kommentare zur Abrufanforderung	Repository-Importstatus
Problembezeichnungen	Abrufanforderung erstellt um	Repository-Lizenz
Problem gesperrt	Abrufanforderungsentwurf	Anzahl offener Repository-Probleme
Meilenstein für das Problem	Abrufanforderung mit der Bezeichnung „Zu“.	Repository-Besitzer
Vorheriger Text des Problems	Abrufanforderungsbezeichnungen	Repository privat
Vorheriger Kommentar zum Problem	Abrufanforderung gesperrt	Repository veröffentlicht um
Vorheriger Meilenstein des Problems	Pull-Anforderung für zusammenführbares Element	Repository mit Stern bei
Vorheriger Titel des Problems	Abrufanforderung zusammengeführt	Repository aktualisiert um
Problem zuvor zugewiesen an	Abrufanforderung zusammengeführt um	Betroffener Bereich der Repository-Schwachstellenwarnung
Problem zuvor mit der Bezeichnung „Zu“ gekennzeichnet	Meilenstein für Abrufanforderung	Externer Bezeichner der Repository-Schwachstellenwarnung
Problemstatus	Vorheriger Textkörper der Abrufanforderung	Repository-Schwachstellenwarnung behoben in
Problemtitel	Vorheriger Titel der Abrufanforderung	Name des Repository-Schwachstellenwarnungspakets
Problem aktualisiert am	Abrufanforderung, die zuvor zugewiesen wurde	Beschreibung des Sicherheitswarnhinweis
Problembenutzer	Abrufanforderung zuvor mit der Bezeichnung „Zu“ gekennzeichnet	ID für Sicherheitswarnhinweis
Meilenstein geschlossen um	Rebaseable für Abrufanforderung	Sicherheitswarnhinweis veröffentlicht um
Meilenstein erstellt um	Überprüfungstext für Abrufanforderung	Schweregrad für Sicherheitswarnhinweis
Meilensteinersteller	Überprüfungskommentar für Abrufanforderung	Zusammenfassung des Sicherheitswarnhinweis
Beschreibung des Meilensteins	Anzahl der Kommentare zur Überprüfung der Abrufanforderung	Sicherheitswarnhinweis aktualisiert am
Meilenstein fällig am	Abrufanforderungs-Prüfungskommentar erstellt um	Sicherheitswarnhinweis zurückgezogen um
Meilensteinstatus	Pfad zur Überprüfung des Kommentars zur Abrufanforderung	Absenderanmeldung
Meilensteintitel	Vorheriger Kommentar zur Überprüfung des Abrufanforderungskommentars	Status-Commit-Nachricht
Meilenstein aktualisiert um	Überprüfungskommentar für Abrufanforderung aktualisiert um	Statuskontext
Organisationsbeschreibung	Abrufanforderungsüberprüfung des vorherigen Textkörpers	Status „Erstellt am“.
Organisationsanmeldung	Überprüfungsstatus der Abrufanforderung	Statusbeschreibung
Vorab-Release	Status der Abrufanforderung	Statusname
Projekttext	Titel der Abrufanforderung	Status State
Projektkarte archiviert	Abrufanforderung aktualisiert um	Status aktualisiert am
Projektkarte erstellt um	Abrufanforderungsbenutzer	Webhook-Ereignis

Um andere Bedingungen in der Weiterleitungsrichtlinie zu verwenden, erstellen Sie eine Weiterleitungsrichtlinie im Modul GitHub WebHook Routing Policies (WebHook-Weiterleitungsrichtlinien), und geben Sie Bedingungen entsprechend Ihren Anforderungen an. Informationen zum Einrichten und Konfigurieren der Webhooks finden Sie unter Richten Sie einen bidirektionalen Webhook für die GitHub-Spoke ein.

Spoke-Auslöser

ServiceNow unterstützt bestimmte Ereignisse auf GitHub, die Auslöser erstellen. Sie müssen zuerst einen Flow mit einer unterstützten Auslöserdefinition konfigurieren. Wenn ein Ereignis, z. B. eine Push-Anforderung, in GitHubauftritt, wird die Nutzlast über einen Webhook an die Instanz ServiceNow gesendet. Danach wird der von Ihnen konfigurierte Flow in der Instanz ServiceNow ausgelöst, um einen -Workflow zu automatisieren. Folgende Ereignisse werden unterstützt:


Kategorie	Auslöser	Beschreibung
Niederlassungsverwaltung	Verzweigung erstellt	Flow wird ausgelöst, wenn Sie eine Verzweigung für GitHuberstellen.
Repository-Verwaltung	Abrufanforderung geöffnet	Der Flow wird ausgelöst, wenn Sie eine neue Abrufanforderung für GitHubinitiieren.
	Abrufanforderung bearbeitet	Der Flow wird ausgelöst, wenn Sie eine Abrufanforderung für GitHubaktualisieren.
	Abrufanforderung geschlossen	Der Flow wird ausgelöst, wenn Sie eine Abrufanforderung für GitHubschließen.
	Abrufanforderung zugewiesen	Der Flow wird ausgelöst, wenn Sie einem Anwender unter GitHubeine Abrufanforderung zuweisen.
	Abrufanforderung erneut geöffnet	Der Flow wird ausgelöst, wenn Sie eine Abrufanforderung für GitHuberneut öffnen.
	Repository-Gabel	Der Flow wird ausgelöst, wenn Sie ein Repository auf GitHubverzweigen .
	Repository-Push	Der Flow wird ausgelöst, wenn Sie in ein Repository unter GitHubverschieben .
Releasemanagement	Release erstellt	Der Flow wird ausgelöst, wenn die Details eines Release am GitHuberstellt werden.
	Release bearbeitet	Der Flow wird ausgelöst, wenn die Details eines Release am GitHubaktualisiert werden.
	Release gelöscht	Flow wird ausgelöst, wenn ein Release auf GitHubentfernt wird.
	Release veröffentlicht	Der Flow wird ausgelöst, wenn ein Release am GitHubveröffentlicht wird.

Informationen zum Einrichten der Auslöser für die Spoke GitHub finden Sie unter Aktivieren Sie die Auslöserdefinition in der Instanz ServiceNow .. Weitere Informationen zur eingehenden Integration finden Sie unter Bedingte und ereignisgesteuerte eingehende Integration.

Spoke-Unterabläufe

GitHub-Spoke stellt einen Beispiel-Subflow zur Verarbeitung verschiedener GitHub -Webhook-Ereignisse bereit. Verfügbare Beispiel-Subflows:

Tabelle : 1. Spoke-Unterabläufe
Subflow	Beschreibung	Unterstütztes Ereignis GitHub
Verarbeiten Sie GitHub-Verzweigungs- und Tag-Webhook-Ereignisse	Verarbeitet Webhook-Ereignisse für Verzweigungen und Tags.	Verzweigung und Tag
Verarbeiten Sie GitHub-Commit-Webhook-Ereignisse	Verarbeitet Commit-Webhook-Ereignisse.	Commit
Webhook-Ereignisse für GitHub-Problem verarbeiten	Verarbeitet Problem-Webhook-Ereignisse.	Problem
Verarbeiten Sie Webhook-Ereignisse für GitHub-Meilensteine	Verarbeitet Meilenstein-Webhook-Ereignisse.	Meilenstein
Verarbeiten Sie die Webhook-Ereignisse des GitHub-Projekts	Verarbeitet Projekt-Webhook-Ereignisse.	Projekt
Verarbeitet GitHub-Abrufanforderungs-Webhook-Ereignisse	Verarbeitet Webhook-Ereignisse für Abrufanforderungen.	Abrufanforderung
Verarbeitet GitHub-Push-Webhook-Ereignisse	Verarbeitet Webhook-Ereignisse für Push-Anforderungen.	Push-Anforderung
Verarbeitet GitHub-Release-Webhook-Ereignisse	Verarbeitet Release-Webhook-Ereignisse.	Release
Verarbeiten Sie Webhook-Ereignisse für das GitHub-Repository	Verarbeitet Repository-Webhook-Ereignisse.	Repository
Verarbeitet GitHub-Sicherheits-Webhook-Ereignisse	Verarbeitet Sicherheits-Webhook-Ereignisse.	Sicherheit
Verarbeiten Sie GitHub-Webhook-Ereignisse	Verarbeitet alle GitHub -Webhook-Ereignisse.	Hinweis: Dieser Subflow verarbeitet alle GitHub -Ereignisse. Sie können diesen Subflow anpassen, um andere GitHub -Webhook-Ereignisse zu verarbeiten, die standardmäßig nicht unterstützt werden.

Um Subflows zu erstellen, um andere GitHub -Webhook-Ereignisse oder die unterstützten GitHub -Webhook-Ereignisse anders zu behandeln, passen Sie den Subflow GitHub-Webhook-Ereignisse verarbeiten an. Dazu müssen Sie eine Kopie des Subflows erstellen, die Nutzlast analysieren und den Subflow entsprechend Ihren Anforderungen anpassen. Die Nutzlast ist eine der Eingaben für den Subflow.

Beim Anpassen von Subflows müssen Sie sicherstellen, dass die Subflows so konfiguriert sind, dass Endlosschleifen vermieden werden.

Hinweis:

Sie müssen Webhooks für die Verwendung des Spoke-Subflows konfigurieren. Informationen zum Einrichten und Konfigurieren des Webhook finden Sie unter Richten Sie einen bidirektionalen Webhook für die GitHub-Spoke ein.
Die Beispiel-Subflows werden standardmäßig als -Benutzer ausgeführt. Es kann für die Ausführung als System konfiguriert werden.
GitHub-Spoke unterstützt Anwendungs-/JSON-Nutzlast. Konfigurieren Sie den Webhook GitHub entsprechend. Siehe GitHub Entwickler In der -Dokumentation finden Sie Anweisungen zum Erstellen und Konfigurieren eines Webhooks.

Spoke-Aktionen

GitHub-Spoke bietet Aktionen zum Verwalten von Verzweigungen, Problemen, Repositorys und Quellcode, wenn Ereignisse in ServiceNoweintreten. Folgende Aktionen sind verfügbar:


Kategorie	Aktion	Beschreibung
Niederlassungsverwaltung	Verzweigung erstellen	Erstellt eine Verzweigung in GitHub basierend auf einer bestimmten Commit-SHA.
	Löschen Sie die Verzweigung	Löscht eine Verzweigung aus dem Repository GitHub.
	Verzweigung abrufen	Ruft die Details einer Verzweigung im Repository GitHub ab.
	Verzweigungsschutz abrufen	Ruft die Einschränkungsdetails der erforderlichen Verzweigung ab.
	Verzweigungen auflisten	Ruft die Liste aller Verzweigungen in einem Repository ab.
	Entfernen Sie den Verzweigungsschutz	Entfernt den Schutz für die erforderliche Verzweigung.
	Aktualisieren Sie den Verzweigungsschutz	Aktualisiert den Schutz für die erforderliche Verzweigung.
Problemverwaltung	Kommentar zu Problem erstellen	Erstellt einen Kommentar zu einem erforderlichen Problem.
	Problem erstellen	Erstellt ein Problem für das erforderliche Repository.
	Löschen Sie den Kommentar zum Problem	Löscht den Kommentar zu einem erforderlichen Problem.
	Problem sperren	Sperrt das erforderliche Problem. Dadurch wird die Konversation nur auf Mitarbeitende beschränkt.
	Kommentare zu Problem suchen	Ruft die Liste der Kommentare zu einem Problem ab.
	Probleme suchen	Ruft die Liste der Probleme für ein Repository ab.
	Entsperren Sie das Problem	Entsperrt das erforderliche Problem. Dadurch wird die Konversation für alle Anwender geöffnet.
	Update-Kommentar zum Problem	Aktualisiert einen Kommentar zu einem Problem.
	Problem aktualisieren	Aktualisiert die Details des erforderlichen Problems.
Metadatenabruf	Felder nach Aktion suchen	Ruft die Liste der Felder für einen Aktionsfilter in der Tabelle „Felder GitHub “ ab.
	Sucht Metadaten von Verzweigungen	Ruft Metadaten der Verzweigungen ab.
	Sucht Metadaten für Probleme	Ruft Metadaten der Probleme ab.
	Sucht Metadaten von Meilensteinen	Ruft Metadaten der Meilensteine ab.
	Sucht nach Metadaten für Abrufanforderungen	Ruft Metadaten der Abrufanforderungen ab.
Organisationsmanagement	Rufen Sie den Organisationsplan ab	Ruft den Plannamen einer Organisation ab.
	Liste der Organisationsmitglieder	Ruft die Liste aller Mitglieder in einer Organisation ab.
	Listet Organisations-Repositorys auf	Ruft die Liste aller Repositorys in einer Organisation ab.
	Entfernen Sie das Organisationsmitglied	Entfernt einen Anwender aus einer Organisation.
	Sucht Stream mit Organisationsereignissen	Ruft die Liste der Ereignisse in einer Organisation basierend auf dem angegebenen Rückblickdatum ab.
	Sucht Stream mit externen Mitarbeitenden der Organisation	Ruft die Liste aller externen Mitarbeitenden in einer Organisation ab.
	Entfernen Sie den externen Mitarbeitenden der Organisation	Entfernt einen externen Mitarbeitenden aus einer Organisation.
	Sucht nach Stream „Organisation mit ausstehenden externen Mitarbeitenden“.	Ruft eine Liste der ausstehenden Mitarbeitenden in einem Repository ab.
	Sucht nach Stream mit Organisationseinladungen	Ruft eine Liste von Einladungen innerhalb einer Organisation ab.
Repository-Verwaltung	Mitarbeitenden hinzufügen	Fügt dem erforderlichen Repository einen Mitarbeitenden hinzu.
	Kommentar zu Abrufanforderung erstellen	Erstellen Sie Überprüfungskommentare zu einer Abrufanforderung.
	Meilenstein erstellen	Erstellt einen Meilenstein für das erforderliche Repository.
	Abrufanforderung erstellen	Erstellt eine Abrufanforderung für ein Repository.
	Erstellen Sie eine Antwort auf den Kommentar zur Überprüfung der Abrufanforderung	Erstellt eine Antwort auf einen Überprüfungskommentar für eine Abrufanforderung.
	Repository erstellen	Erstellt ein Repository in GitHub.
	Löscht den Kommentar in der Abrufanforderung	Löscht den Überprüfungskommentar zu einer Abrufanforderung.
	Meilenstein löschen	Löscht den Meilenstein aus dem erforderlichen Repository.
	Listet Kommentare bei Abrufanforderung auf	Ruft die Liste aller Überprüfungskommentare zu einer Abrufanforderung ab.
	Meilensteine auflisten	Ruft die Liste aller Meilensteine in einem Repository ab.
	Listet Repository-Ereignisse auf	Ruft die Liste der Ereignisse in einem Repository ab.
	Abrufanforderungen suchen	Ruft die Details von Abrufanforderungen für ein Repository ab.
	Repositorys suchen	Ruft die Details von Repositorys basierend auf einem bestimmten Anwender oder einer bestimmten Organisation ab.
	Abrufanforderung zusammenführen	Führt die Abrufanforderung mit einem Repository zusammen.
	Mitarbeitenden entfernen	Entfernt einen Mitarbeitenden aus einem Repository.
	Update-Kommentar zu Abrufanforderung	Aktualisiert Überprüfungskommentare, die für eine Abrufanforderung angegeben wurden.
	Meilenstein aktualisieren	Aktualisiert die Details eines Meilensteins in einem Repository.
	Abrufanforderung aktualisieren	Aktualisiert die Details einer Abrufanforderung in einem Repository.
	Update-Repository	Aktualisiert die Details eines Repositorys in GitHub.
Quellcodeverwaltung	Kommentar bei Commit erstellen	Erstellt einen Kommentar für den erforderlichen Commit mithilfe seiner SHA.
	Erstellen oder aktualisieren Sie eine Datei	Erstellt eine Datei oder aktualisiert eine vorhandene Datei in einem Repository.
	Kommentare nach Commit-ID abrufen	Ruft Kommentare ab, die für einen einzelnen Commit bereitgestellt wurden.
	Commit-Informationen nach ID abrufen	Ruft den Inhalt der erforderlichen Commit-Referenz ab.
	Dateiinhalt abrufen	Ruft den Inhalt einer Datei in einem Repository ab. Hinweis: Diese Aktion unterstützt Dateien mit einer Dateigröße von bis zu 1 MB.
	Commits in einem Repository auflisten	Ruft die Details aller Commits ab, die in einem Repository vorgenommen wurden.
Anwenderverwaltung	Ruft alle Anwender für Enterprise Server ab	Ruft die Liste aller GitHub Enterprise Server-Anwender ab.
	Listen Sie Organisationen für den authentifizierten Anwender auf	Ruft die Liste der Organisationen ab, denen der angemeldete Anwender angehört.
	Anwender sperren	Hält einen GitHub -Anwenderaccount an.
	Authentifizierten Anwender suchen	Ruft Informationen zum authentifizierten Anwender ab.

Spoke-Module

Die GitHub -Spoke fügt diese Module Ihrer -Instanz ServiceNow hinzu.


Modul	Beschreibung
GitHub Besitzer	Zeigt die Besitzerdatensätze für GitHub an, die Sie erstellt haben.
GitHub Repositorys	Zeigt die Details der GitHub -Repositorys an, die den GitHub -Besitzern zugeordnet sind.

Alias-Anforderungen für Verbindungen und Anmeldeinformationen

IntegrationHub verwendet Aliasse, um Verbindungs- und Anmeldeinformationen sowie OAuth-Anmeldeinformationen zu verwalten. Wenn Sie ein Alias verwenden, müssen Sie nicht mehrere Anmeldeinformations- und Verbindungsinformationsprofile konfigurieren, wenn Sie mehrere Umgebungen verwenden. Wenn sich die Verbindungs- oder Anmeldeinformationen ändern, müssen Sie die Aktionen, die die Verbindung verwenden, nicht aktualisieren.

Informationen zum Einrichten der Spoke finden Sie unter Richten Sie die GitHub -Spoke ein.