Google Chat で Jenkins アプリを使用する

Jenkins のビルドに関する通知を受け取るには、Chat で Jenkins アプリを使用します。

始める前に

アプリをインストールするには、Google Workspace 管理者から許可を得る必要があります。
Chat にアプリを追加します。詳しくは、アプリを見つけて Chat に追加する方法をご覧ください。

ステップ 1: Jenkins サーバーで Chat プラグインをインストールする

このタスクを行うには、Jenkins の管理者としてログインする必要があります。

デバイスに Chat Notifier Plugin file をダウンロードします。
[Jenkins] で、[Manage Jenkins] [Manage Plugins] を選択します。
“Advanced” タブの “Upload Plugin,” でプラグインファイルを選択します。
[Upload] をクリックします。

これで、組織内のユーザーが Jenkins アプリをインストールして設定できるようになります。

ステップ 2: Chat で Jenkins アプリを設定する

Jenkins から Chat にビルド通知が送信されるようにするには、Jenkins アプリによって生成されるトークンが必要です。Jenkins アプリを追加したスペースごとにトークンが生成されます。ビルド通知は、Jenkins アプリが追加されているすべてのスペースに送信されます。

Google Chat を開きます。
ダイレクトメッセージを開くか、スペースに移動します。
アプリでトークンをコピーします。
（省略可）トークンを再度表示するには、次のどちらかの操作を行います。
- ダイレクトメッセージで、「token」と入力します。
- スペースで、「/jenkins_token」と入力します。
（省略可）トークンを再生成するには、[Regenerate Token] をクリックします。

ステップ 3: 通知を設定する

“Jenkins.” を開きます。
Chat の通知対象として追加するビルドに移動します。
“Build,” で “Add build step,” の横にある下矢印アイコンをクリックします。
受け取る通知を選択します。
“Post-build Actions,” で “Add post-build actions,” の横にある下矢印アイコンをクリックします。
[Notify Hangouts Chat] を選択します。
オプションを選択し、Chat からコピーしたトークンを貼り付けます。
- Chat: 以前に設定したグローバル設定を選択します。
- Chat Token: 特定の Chat スペースのグローバル構成をオーバーライドします。
Chat で通知を受け取る項目のチェックボックスをオンにします。
[Save] をクリックします。

ビルドイベント通知で、次のいずれかをクリックします。

Open Build: Jenkins でビルド構成を変更できます。
View Details: 通知に関する情報を表示できます。

ステップ 4: パイプラインの通知を受け取る

[Jenkins] を開きます。
Chat の通知対象として追加するパイプラインを開きます。
パイプラインのスクリプトに次のように入力します。

hangoutsNotify message: "This message is from a pipeline!",token: {your_jenkins_token},threadByJob: false

ヒント: {your_jenkins_token} を、チャットアプリでリクエストしたトークンに置き換えてください。threadByJob を true または false に設定できます。
[Save] をクリックします。

スペースでアプリを使用する

スペースでアプリを使用するには、アプリに対するメッセージ内と、アプリからのメッセージへの返信内に、アプリの名前リンクを記述する必要があります。これにより、スペース内の他のユーザーではなく、目的のアプリにメッセージが送信されるようになります。「/jenkins_」と入力して、プルダウンから目的のコマンドを選択することもできます。

Chat からビルドをトリガーする

Jenkins がインストールされているスペース内で、または Jenkins のダイレクトメッセージ内で、「/jenkins_triggerJob」と入力します。
ダイアログが開いたら、次の必須項目を入力します。"Jenkins URL," "Job Name," "UserName" and "ApiToken."
[Submit] をクリックします。

オプションで、トークンを保存するかどうかを選択できます（トークンが表示されることはありません）。また、オプションのパラメータをビルドリクエストに渡すこともできます。

_{Google、Google Workspace、および関連するマークとロゴは、Google LLC の商標です。その他すべての企業名および商品名は、関連各社の商標または登録商標です。}