GitHub Spoke

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 8 Minuten Lesedauer
  • Verwalten Sie die verteilte Versionskontrolle und den Quellcode in GitHub von Ihrer ServiceNow-Instanz aus. Erstellen Sie Flows in ServiceNow, um gemeinschaftliche Features wie die Nachverfolgung von Fehlern, Feature-Anforderungen und Aufgaben für Projekte in GitHub zu verwalten. Zeigen Sie aussagekräftige Nutzungsdaten für GitHub Enterprise Cloud- und GitHub Enterprise Server-Softwareabonnements an, und analysieren Sie diese, damit Sie veraltete Lizenzen zurückfordern können.

    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 v2.4.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
    • Benutzer mit Administratoranmeldeinformationen
    • Token zum Authentifizieren der Instanz ServiceNow .
    Siehe GitHub Dokumentation für Anweisungen zum Erstellen des Kontos GitHub und zum Generieren des Tokens.

    GitHub Webhooks-Modul

    Bidirektionale Webhooks können so eingerichtet werden, dass sie über die erforderlichen Events 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, für die Sie benachrichtigt werden möchten. Wenn die Bedingungen erfüllt sind, löst die Routing-Richtlinie den zugehörigen Subflow aus, der wiederum die GitHub -Aufgaben automatisiert.

    Die bidirektionalen Webhooks erfordern ein separates Setup und können unabhängig verwendet werden, ohne die Spoke-Aktionen zu verwenden. Standardmäßig ist die Anwendung GitHub Webhooks im GitHub-Spoke verfügbar und verfügt über die folgenden Module:
    • GitHub Webhook-Registrierungen
    • GitHub WebHook-Routing-Richtlinien
    Verwenden Sie das Modul GitHub Webhook-Registrierungen, um ein Token zuzuweisen und den API-Pfad bereitzustellen. Sie müssen die Rückruf-URL hier generieren und diese URL in GitHubangeben. Eine standardmäßige Routing-Richtlinie wird im Modul GitHub WebHook-Routing-Richtlinien bereitgestellt. Die standardmäßige Weiterleitungsrichtlinie unterstützt die folgenden GitHub Felder:
    Unterstützte GitHub Felder
    Aktion Projektkartenersteller Ref
    Basisreferenz Hinweis zur Projektkarte Referenztyp
    Commit-Kommentar Projektkarte Vorherige Notiz Release-Assets
    Commit-Kommentar erstellt am Projektkarte aktualisiert am Release-Autor
    Commit-Kommentarpfad Projektspalte erstellt am Release-Text
    Commit-Kommentar aktualisiert am Name der Projektspalte Release erstellt am
    Commit-Kommentar Anwender Vorheriger Name der Projektspalte Release-Entwurf
    Veröffentlichung erzwingen Projektspalte aktualisiert am Release-Name
    GitHub-Instanz-URL Projekt erstellt am Release veröffentlicht am
    Problem zugewiesen an Projektname Release-Tag-Name
    Problembeauftragte Vorheriger Projekttext Releaseziel-Commitish
    Problemtext Vorheriger Name des Projekts Repository archiviert
    Problem geschlossen um Projektstatus Repository erstellt am
    Problemkommentar Projekt aktualisiert am Repository-Beschreibung
    Anzahl der Problemkommentare Abrufanforderung zugewiesen an Repository deaktiviert
    Problemkommentar erstellt am Beauftragte der Abrufanforderung Vollständiger Name des Repositorys
    Problemkommentar aktualisiert am Pull-Anforderungstext Repository weist Probleme auf
    Problem erstellt am Abrufanforderung geschlossen um Repository enthält Projekte
    Problem mit der Bezeichnung „An“. Anzahl der Abrufanforderungskommentare Repository-Importstatus
    Problembezeichnungen Abrufanforderung erstellt am Repository-Lizenz
    Problem gesperrt Abrufanforderungsentwurf Anzahl offener Probleme im Repository
    Meilenstein des Problems Abrufanforderung mit Bezeichnung an Repository-Besitzer
    Vorheriger Text des Problems Bezeichnungen der Abrufanforderung Repository privat
    Vorheriger Kommentar zum Problem Abrufanforderung gesperrt Repository veröffentlicht um
    Vorheriger Meilenstein für Problem Abrufanforderung zusammenführbar Repository mit Stern um
    Vorheriger Titel des Problems Abrufanforderung zusammengeführt Repository aktualisiert am
    Problem zuvor zugewiesen an Abrufanforderung zusammengeführt um Betroffener Bereich der Repository-Schwachstellenwarnung
    Problem zuvor mit der Bezeichnung „An“ gekennzeichnet Pull Request-Meilenstein Externer Bezeichner der Repository-Schwachstellenwarnung
    Problemstatus Vorheriger Text der Abrufanforderung Repository-Schwachstellenwarnung behoben in
    Titel des Problems Vorheriger Titel der Abrufanforderung Name des Repository-Schwachstellenwarnungs-Pakets
    Problem aktualisiert am Abrufanforderung zuvor zugewiesen an Beschreibung der Sicherheitsempfehlung
    Problemanwender Abrufanforderung zuvor gekennzeichnet mit ID der Sicherheitsempfehlung
    Meilenstein „Geschlossen um“. Rebaseable für Abrufanforderung Sicherheitshinweis veröffentlicht um
    Meilenstein erstellt am Überprüfungstext der Abrufanforderung Schweregrad der Sicherheitsempfehlung
    Meilensteinersteller Überprüfungskommentar für Abrufanforderung Zusammenfassung der Sicherheitsempfehlung
    Meilensteinbeschreibung Anzahl der Überprüfungskommentare für Abrufanforderung Sicherheitshinweis aktualisiert am
    Meilenstein fällig am Überprüfungskommentar für Abrufanforderung erstellt am Sicherheitshinweis zurückgezogen um
    Meilensteinstatus Dateipfad für Überprüfungskommentar für Abrufanforderung Absenderanmeldung
    Meilensteintitel Überprüfungskommentar für Abrufanforderung Vorheriger Kommentar Status-Commit-Nachricht
    Meilenstein aktualisiert am Überprüfungskommentar für Abrufanforderung aktualisiert am Statuskontext
    Organisationsbeschreibung Abrufanforderungsüberprüfung Vorheriger Text Status Erstellt am
    Organisationsanmeldung Überprüfungsstatus der Abrufanforderung Statusbeschreibung
    Vorabversion Status der Abrufanforderung Statusname
    Projekttext Titel der Abrufanforderung Status Status
    Projektkarte archiviert Abrufanforderung aktualisiert am Status aktualisiert am
    Projektkarte erstellt am Abrufanforderungsbenutzer Webhook-Event

    Um andere Bedingungen in der Routing-Richtlinie zu verwenden, erstellen Sie eine Routing-Richtlinie im Modul GitHub WebHook-Routing-Richtlinien, und geben Sie die Bedingungen gemäß Ihren Anforderungen an. Informationen zum Einrichten und Konfigurieren der Webhooks finden Sie unter Richten Sie den bidirektionalen Webhook für ein GitHub-Spoke.

    Spoke-Unterabläufe

    GitHub-Spoke stellt einen Beispiel-Subflow zur Verarbeitung verschiedener GitHub -Webhook-Events bereit. Verfügbare Beispiel-Subflows:
    Tabelle : 1. Spoke-Unterabläufe
    Subflow Beschreibung Unterstütztes GitHub Event
    Verarbeitet GitHub-Verzweigungs- und Tag-Webhook-Ereignisse Verarbeitet Verzweigungs- und Tag-Webhook-Ereignisse. Verzweigung und Tag
    Verarbeitet GitHub-Commit-Webhook-Ereignisse Verarbeitet Commit-Webhook-Ereignisse. Commit
    Verarbeitet GitHub-Problem-Webhook-Ereignisse Verarbeitet Problem-Webhook-Ereignisse. Vorfall
    Verarbeitet GitHub-Meilenstein-Webhook-Ereignisse Verarbeitet Meilenstein-Webhook-Ereignisse. Meilenstein
    Verarbeitet Webhook-Ereignisse des GitHub-Projekts Verarbeitet Projekt-Webhook-Ereignisse. Projekt
    Verarbeitet GitHub-Abrufanforderungs-Webhook-Ereignisse Verarbeitet Abrufanforderungs-Webhook-Ereignisse. Abrufanforderung
    Verarbeitet GitHub-Push-Webhook-Ereignisse Verarbeitet Push-Anforderungs-Webhook-Ereignisse. Push-Anforderung
    Verarbeitet GitHub-Release-Webhook-Ereignisse Verarbeitet Release-Webhook-Ereignisse. Release
    Verarbeitet Webhook-Ereignisse im GitHub-Repository Verarbeitet Repository-Webhook-Ereignisse. Repository
    Verarbeitet GitHub-Sicherheits-Webhook-Ereignisse Verarbeitet Sicherheits-Webhook-Ereignisse. Sicherheit
    Verarbeitet 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-Events zu verarbeiten, die standardmäßig nicht unterstützt werden.

    Um Subflows zur Behandlung anderer GitHub Webhook-Ereignisse zu erstellen 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 gemäß Ihren Anforderungen anpassen. Nutzlast ist eine der Eingaben in 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 konfigurieren, um den Spoke-Subflow zu verwenden. Informationen zum Einrichten und Konfigurieren des Webhooks finden Sie unter Richten Sie den bidirektionalen Webhook für ein GitHub-Spoke.
    • Die Beispiel-Subflows werden standardmäßig als Benutzer ausgeführt. Es kann so konfiguriert werden, dass es als System ausgeführt wird.
    • GitHub-Spoke unterstützt Anwendungs-/JSON-Nutzlast. Konfigurieren Sie den Webhook GitHub entsprechend. Siehe GitHub Entwickler -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 Events in ServiceNowauftreten. Folgende Aktionen sind verfügbar:

    Kategorie Aktion Beschreibung
    Zweigstellenverwaltung Verzweigung erstellen Erstellt eine Verzweigung in GitHub basierend auf einem 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.
    Rufen Sie Verzweigungsschutz ab Ruft die Einschränkungsdetails der erforderlichen Verzweigung ab.
    Listenverzweigungen 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 Erstellen Sie einen Kommentar zu Problem Erstellt einen Kommentar zu einem erforderlichen Problem.
    Problem erstellen Erstellt ein Problem für das erforderliche Repository.
    Kommentar zu Problem löschen Löscht den Kommentar zu einem erforderlichen Problem.
    Problem sperren Sperrt das erforderliche Problem. Dadurch wird die Konversation nur auf Mitarbeitende beschränkt.
    Sucht nach Kommentaren zum Problem Ruft die Liste der Kommentare zu einem Problem ab.
    Suchen Sie nach Problemen Ruft die Liste der Probleme für ein Repository ab.
    Problem entsperren Schaltet das erforderliche Problem frei. Dadurch wird die Konversation für alle Benutzer geöffnet.
    Kommentar zu Problem aktualisieren Aktualisiert einen Kommentar zu einem Problem.
    Problem aktualisieren Aktualisiert die Details des erforderlichen Problems.
    Metadatenabruf Sucht nach Feldern nach Aktion Ruft die Liste der Felder für einen Aktionsfilter in der Tabelle GitHub „ Felder“ ab.
    Sucht nach Verzweigungsmetadaten Ruft Metadaten der Verzweigungen ab.
    Sucht nach Metadaten zu Problemen Ruft Metadaten der Probleme ab.
    Sucht nach Meilenstein-Metadaten 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.
    Listen Sie die Organisationsmitglieder auf Ruft die Liste aller Mitglieder in einer Organisation ab.
    Listen Sie die Organisations-Repositorys auf Ruft die Liste aller Repositorys in einer Organisation ab.
    Entfernen Sie das Organisationsmitglied Entfernt einen Anwender aus einer Organisation.
    Sucht nach Stream „Organisationsereignisse“. Ruft die Liste der Ereignisse in einer Organisation basierend auf dem angegebenen Rückblickdatum ab.
    Sucht nach Stream „Organisation außerhalb von Mitarbeitenden“. Ruft externe Mitarbeitende in einer Organisation ab.
    Organisation außerhalb des Mitarbeitenden entfernen Entfernt externe Mitarbeitende aus einer Organisation
    Sucht nach Stream „Organisation ausstehender externer Mitarbeitender“. Ruft ausstehende Mitarbeitende in einer Organisation ab.
    Sucht nach Stream „Organisationseinladungen“. Ruft Einladungen in einer Organisation ab.
    Repository-Verwaltung Mitarbeitenden hinzufügen Fügt einen Mitarbeitenden dem erforderlichen Repository hinzu.
    Erstellen Sie einen Kommentar zur Abrufanforderung Erstellen Sie Überprüfungskommentare zu einer Abrufanforderung.
    Erstellen Sie einen Meilenstein Erstellt einen Meilenstein für das erforderliche Repository.
    Erstellen Sie eine Abrufanforderung Erstellt eine Abrufanforderung für ein Repository.
    Erstellt eine Antwort auf den Überprüfungskommentar der Abrufanforderung Erstellt eine Antwort auf einen Überprüfungskommentar für eine Abrufanforderung.
    Erstellen Sie ein Repository Erstellt ein Repository in GitHub.
    Kommentar zu Abrufanforderung löschen Löscht den Überprüfungskommentar zu einer Abrufanforderung.
    Meilenstein löschen Löscht den Meilenstein aus dem erforderlichen Repository.
    Listet Kommentare zur 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 Events in einem Repository ab.
    Suchen Sie nach Abrufanforderungen Ruft die Details von Abrufanforderungen für ein Repository ab.
    Suchen Sie nach Repositorys 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.
    Kommentar zu Abrufanforderung aktualisieren Aktualisiert den Überprüfungskommentar, der für eine Abrufanforderung bereitgestellt wird.
    Meilenstein aktualisieren Aktualisiert die Details eines Meilensteins in einem Repository.
    Aktualisieren Sie die Abrufanforderung Aktualisiert die Details einer Abrufanforderung in einem Repository.
    Aktualisieren Sie das Repository Aktualisiert die Details eines Repositorys in GitHub.
    Quellcodeverwaltung Kommentar zu Commit erstellen Erstellt einen Kommentar für den erforderlichen Commit mit seinem SHA.
    Erstellen oder aktualisieren Sie eine Datei Erstellt eine Datei oder aktualisiert eine vorhandene Datei in einem Repository.
    Ruft Kommentare nach Commit-ID ab Ruft Kommentare für einen einzelnen Commit ab.
    Ruft Commit-Informationen nach ID ab 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.
    Listet Commits in einem Repository auf Ruft die Details aller Commits ab, die für ein Repository durchgeführt wurden.
    Anwenderverwaltung Alle Benutzer für Enterprise-Server abrufen Ruft die Liste aller GitHub Enterprise Server-Anwender ab.
    Liste der Organisationen für den authentifizierten Anwender Ruft die Liste der Organisationen ab, denen der angemeldete Benutzer angehört.
    Anwender sperren Hält einen GitHub -Benutzeraccount an.
    Authentifizierten Anwender suchen Ruft Informationen zum authentifizierten Anwender ab.

    Spoke-Module

    Die Spoke GitHub fügt Ihrer Instanz ServiceNow ] diese Module hinzu.
    Modul Beschreibung
    GitHub Besitzer Zeigt die GitHub Besitzerdatensätze 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 Spoke GitHub ein.