Zum Inhalt springen

GitHub Update File-Aktivität

Einführung

Eine GitHub Update File-Aktivität, die ihre GitHub-Verbindung verwendet, aktualisiert eine Datei in GitHub und ist als Ziel gedacht, um Daten in einem Vorgang zu konsumieren.

Vorsicht

Die Update File-Aktivität ist veraltet. Wir empfehlen die Verwendung der Update-Aktivität stattdessen.

Erstellen einer GitHub Update File-Aktivität

Eine Instanz einer GitHub Update File-Aktivität wird aus einer GitHub-Verbindung unter Verwendung des Aktivitätstyps Update File erstellt.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Entwurfsfläche oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Entwurfsfläche ein. Weitere Einzelheiten finden Sie unter Erstellen einer Aktivitäts- oder Toolinstanz in Komponentenwiederverwendung.

Eine vorhandene GitHub Update File-Aktivität kann von diesen Orten aus bearbeitet werden:

Konfigurieren einer GitHub Update File-Aktivität

Befolgen Sie diese Schritte, um eine GitHub Update File-Aktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und spezifizieren Sie die Einstellungen

In diesem Schritt geben Sie einen Namen für die Aktivität ein und spezifizieren die Datei. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

GitHub Update File activity configuration step 1

Hinweis

Felder mit einem Variablen-Icon unterstützen die Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder, indem Sie eine öffnende eckige Klammer [ in das Feld eingeben oder indem Sie auf das Variablen-Icon klicken, um eine Liste der vorhandenen Variablen anzuzeigen.

  • Name: Geben Sie einen Namen ein, um die Aktivität zu identifizieren. Der Name muss für jede GitHub Update File-Aktivität einzigartig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten.

  • GitHub Repository Name: Geben Sie den Namen des Repositories ein, das die zu aktualisierende Datei enthält.

  • File Path of File to Be Updated: Geben Sie einen gültigen Dateipfad ein (zum Beispiel path/file.txt). Der Pfad sollte auf ein vorhandenes Verzeichnis in der GitHub-Instanz verweisen.

  • Commit Message: Geben Sie eine Commit-Nachricht ein, um dieses Commit zur Aktualisierung der Datei im Repository zu identifizieren. Die Commit-Nachricht sollte für jede Update File-Aktivität einzigartig sein.

  • SHA: Geben Sie die SHA für die Datei ein, die entweder von der Create file activity oder der Query file activity zurückgegeben wurde.

  • Save & Exit: Wenn aktiviert, klicken Sie, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

  • Next: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum nächsten Schritt fortzufahren. Die Konfiguration wird nicht gespeichert, bis Sie auf die Schaltfläche Fertig im letzten Schritt klicken.

  • Discard Changes: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fragt Sie, ob Sie die Änderungen wirklich verwerfen möchten.

Step 2: Überprüfen der Datenschemata

Alle Anfrage- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schrittes wird im Folgenden beschrieben.

GitHub Update File activity configuration step 2

  • Daten-Schemas: Diese Daten-Schemas werden von benachbarten Transformationen übernommen und während der Transformation Mapping erneut angezeigt.

    Hinweis

    Daten, die in einer Transformation bereitgestellt werden, haben Vorrang vor der Aktivitätskonfiguration.

    Der GitHub-Connector verwendet die GitHub REST API. Weitere Informationen zu den Schema-Knoten und -Feldern finden Sie in der API-Dokumentation.

    Die Anforderungs- und Antwort-Daten-Schemas bestehen aus diesen Knoten und Feldern:

    Anforderungs-Schema Knoten/Feld Beschreibung
    updateFileRequest Knoten der Update-Dateianforderung
    content Anforderungsinhalt
    Antwort-Schema Knoten/Feld Beschreibung
    updateFileResponse Knoten der Update-Dateiantwort
    repoName Name des Datei-Repositorys
    filePath Der Dateipfad
    fileSha Der Dateisummen-Hash
    commitMessage Zurückgegebene Commit-Nachricht
    errorMessage Zurückgegebene Fehlermeldung

  • Aktualisieren: Klicken Sie auf das Aktualisierungssymbol oder das Wort Aktualisieren, um die Schemata vom GitHub-Endpunkt neu zu generieren. Diese Aktion regeneriert auch ein Schema an anderen Stellen im Projekt, an denen dasselbe Schema referenziert wird, wie in einer benachbarten Transformation.

  • Zurück: Klicken Sie, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • Fertig: Klicken Sie, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.

  • Änderungen verwerfen: Nachdem Sie Änderungen vorgenommen haben, klicken Sie, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Eine Nachricht fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine GitHub Update File-Aktivität konfiguriert haben, vervollständigen Sie die Konfiguration des Vorgangs, indem Sie andere Aktivitäten oder Tools als Vorgangsschritte hinzufügen und konfigurieren. Sie können auch die Betriebseinstellungen konfigurieren, die die Möglichkeit umfassen, Vorgänge zusammenzuführen, die sich in denselben oder unterschiedlichen Workflows befinden.

Menüaktionen für eine Aktivität sind im Projektbereich und auf der Entwurfsgrafik zugänglich. Weitere Informationen finden Sie im Aktivitätsaktionsmenü in Connector-Grundlagen.

GitHub Update File-Aktivitäten können als Ziel mit diesen Vorgangsmustern verwendet werden:

Ein typischer Anwendungsfall ist die Verwendung einer GitHub Update File-Aktivität im Zwei-Transformationsmuster. In diesem Beispiel erstellt die erste Transformation (Update File Request) eine Anforderungsstruktur, die an die GitHub Update File-Aktivität übergeben wird. Die zweite Transformation (Update File Response) empfängt die Antwortstruktur, die dann von einer Variablen Write-Aktivität (Write Update File Response) in eine Variable geschrieben wird, und eine Nachricht wird dann durch das Skript Write to Operation Log protokolliert:

GitHub update file operation

Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Speicherort und verwenden Sie dann diesen temporären Speicherort in der Skriptfunktion.

Wenn Sie bereit sind, deployen und ausführen Sie den Vorgang und validieren Sie das Verhalten, indem Sie die Vorgangsprotokolle überprüfen.