Jenkins App für Google Chat

Sie können die Jenkins App in Google Chat verwenden, um Benachrichtigungen zu Jenkins-Builds zu erhalten.

Hinweise

• Sie benötigen die entsprechende Berechtigung von Ihrem Google Workspace-Administrator, um Apps zu installieren.
• Fügen Sie die App zu Google Chat hinzu. Informationen zum Suchen und Hinzufügen von Apps zu Google Chat

Schritt 1: Chat-Plug-in auf dem Jenkins-Server installieren

Für diese Aufgabe müssen Sie sich als Jenkins-Administrator anmelden.

1. Laden Sie die Chat Notifier Plugin file auf Ihr Gerät herunter.
2. Wählen Sie unter „Jenkins“ die Option Manage Jenkins Manage Plugins aus.
3. Wählen Sie auf dem Tab “Advanced” unter “Upload Plugin,” die Plug-in-Datei aus.
4. Klicken Sie auf Upload.

Nutzer in Ihrer Organisation können die Jenkins App jetzt installieren und einrichten.

Schritt 2: Jenkins App in Google Chat einrichten

Zum Senden von Build-Benachrichtigungen an Google Chat benötigt Jenkins das von der App generierte Token. Jeder Gruppenbereich, in dem Sie die App hinzufügen, erhält ein Token. Die App sendet Benachrichtigungen an alle Gruppenbereiche, in denen sie Mitglied ist.

1. Öffnen Sie Google Chat.
2. Öffnen Sie eine Direktnachricht oder rufen Sie einen Gruppenbereich auf.
3. Kopieren Sie das Token in der App.
4. Optional: Wählen Sie eine Option aus, um sich das Token noch einmal anzeigen zu lassen:
   • Geben Sie in einer Direktnachricht token ein.
   • Geben Sie in einem Gruppenbereich /jenkins_token ein.
5. Optional: Klicken Sie auf Regenerate Token, um das Token neu zu generieren.

Schritt 3: Benachrichtigungen einrichten

1. Öffnen Sie “Jenkins.”
2. Rufen Sie den Build auf, für den Sie Chatbenachrichtigungen hinzufügen möchten.
3. Klicken Sie unter “Build,” neben “Add build step,” auf den Drop-down-Pfeil .
4. Wählen Sie aus, welche Benachrichtigungen Sie erhalten möchten.
5. Klicken Sie unter “Post-build Actions,” neben “Add post-build actions,” auf den Drop-down-Pfeil .
6. Wählen Sie Notify Hangouts Chat aus.
7. Wählen Sie eine Option aus und fügen Sie das Token ein, das Sie aus Google Chat kopiert haben.
   • Chat: Wählen Sie eine zuvor eingerichtete globale Konfiguration aus.
   • Chat Token: Überschreiben Sie die globale Konfiguration für einen bestimmten Chatbereich.
8. Setzen Sie Häkchen neben den Elementen, für die Sie Benachrichtigungen in Google Chat erhalten möchten.
9. Klicken Sie auf Save.

Klicken Sie in einer Build-Ereignisbenachrichtigung auf:

• Open Build: Dadurch wird die Build-Konfiguration in Jenkins geändert.
• View Details: Dadurch können Sie Informationen zur Benachrichtigung aufrufen.

Schritt 4: Benachrichtigungen für eine Pipeline erhalten

1. Öffnen Sie „Jenkins“.
2. Öffnen Sie die Pipeline, für die Sie Chatbenachrichtigungen hinzufügen möchten.

3. Geben Sie im Pipeline-Skript Folgendes ein:
   
   hangoutsNotify message: "This message is from a pipeline!",token: {your_jenkins_token},threadByJob: false
   
   Tipp: Achten Sie darauf, {your_jenkins_token} durch das Token zu ersetzen, das Sie von der Chat-App angefordert haben. Sie können threadByJob auf true oder false festlegen.

4. Klicken Sie auf Speichern.

App in Gruppenbereichen verwenden

Wenn Sie die App in Gruppenbereichen verwenden möchten, müssen Sie sie in jeder Nachricht an die App und in Antworten auf Nachrichten der App @erwähnen. Mit der @Erwähnung wird bestätigt, dass Sie die Nachricht an die App und nicht an andere im Gruppenbereich senden. Sie können auch /jenkins_ eingeben und den gewünschten Befehl aus dem Drop-down-Menü auswählen.

Builds über Google Chat auslösen

1. Geben Sie in einem Gruppenbereich mit installiertem Jenkins oder in einer Jenkins-Direktnachricht /jenkins_triggerJob ein.
2. Füllen Sie im angezeigten Dialogfeld die erforderlichen Felder aus: "Jenkins URL," "Job Name," "UserName" and "ApiToken."
3. Klicken Sie auf Submit.

Sie können auswählen, ob Sie das Token speichern (es wird nie angezeigt) und optionale Parameter an die Build-Anfrage übergeben möchten.

_{Google, Google Workspace sowie zugehörige Marken und Logos sind Marken von Google LLC. Alle anderen Unternehmens- und Produktnamen sind Marken der Unternehmen, mit denen sie verbunden sind.}