概要

現在Flutterを用いたモバイルアプリの開発をしており、内部でのテスト時はDeployGateでアプリの配布を行っています。
特定のブランチにマージされた場合にビルド・DeployGateにアップロードするようにCIが設定されているのですが、マージされたプルリクエストとDeployGateにアップロードされたアプリのリビジョン番号がわからなくなる時があります。
CIのログを見ればわかるのですが、プルリクエストの内容とDeployGateのリビジョン番号を紐付けしてSlackに通知できるように設定してみたのでまとめたいと思います。

前準備(Slack)

Slackに通知するためにWebhook URLを取得します。
今回はカスタムインテグレーション(旧方式)の「Incoming Webhook」を利用しました。
はじめてSlackにインテグレーションを追加する場合はこちらを参考にした方が良いと思います。
SlackのWebhook URL取得手順

以下は既にSlackのカスタムインテグレーションに「Incoming Webhook」が追加されている場合の手順となります。

1. 設定の追加

Slackを起動後ワークスペースをクリックして「以下をカスタマイズ: ワークスペース名」をクリック
開いたページの左側にある「App管理」をクリック
「カスタムインテグレーション」をクリックして「Incoming Webhook」をクリック

Incoming Webhookアイコン下の「設定をリクエストする」(権限によっては設定を追加する)をクリック

2. 設定の編集

設定を追加するをクリック後、個別の設定画面に遷移するので以下を入力・編集する
変更した名前・アイコンはプレビューに反映される
- 投稿するチャンネル
- 説明ラベル(任意)
- 名前をカスタマイズ(任意)
- アイコンをカスタマイズする(任意)

3. 設定の保存

編集が完了したら「設定を保存する」をクリック
設定画面に表示されているWebhook URLは後で使用するので何処かにメモしておくこと

CIの設定

自分が関わっているアプリではiOSのビルドはBitrise、AndroidのビルドはCircle CIを利用しています。
両方通知が必要なのでBitrise・Circle CIどちらも手順も記載します。

1. Bitrise

BitriseからDeployGateにアップロードが完了した場合は$DEPLOYGATE_UPLOAD_APP_STEP_RESULT_JSON内のresults変数内、revisionにリビジョン番号が保存されます。
この値を参照してSlackに通知するように設定します。

1.1 リビジョン番号保存用の環境変数を作成

Bitriseにログイン後設定したいリポジトリをクリックして「Workflow」をクリック
上側のタブの「Env Vars」をクリック
Slack通知を行いたいWorkflowのところの「Add New」をクリックして変数名と値を入力
※今回はIOS_DEPLOY_GATE_REVISIONと設定した

1.2 Workhflowの追加(script)

上タブの「Workflows」をクリック
Slack通知を行いたいWorkflowを選択後、「DeployGate Upload」をクリック
output variablesの値を確認しておく

「DeployGate Upload」下の「+」ボタンをクリックして「Script」を選択
以下のコマンドを「Script content」に設定

#!/usr/bin/env bash
# fail if any commands fails
set -e
# debug log
set -x

IOS_DEV=`echo $DEPLOYGATE_UPLOAD_APP_STEP_RESULT_JSON | ruby -rjson -e "puts JSON.parse(STDIN.read)['results']['revision']"`
envman add --key IOS_DEPLOY_GATE_REVISION --value $IOS_DEV

1.3 Workhflowの追加(Slack message)

先程追加したscript下の「+」ボタンをクリックして「Send a Slack message」を選択
以下の値を設定する(他は任意)
設定が完了したら「Saved」をクリックして保存する

• Slack Webhook URL：先程メモしたWebhook URLを入力
  ※URLを直接入力しても良いが、Webhook URLを環境変数に追加して$環境変数名とした方が良い
• Text of the message to send.：先程設定した環境変数を含むようにSlack通知したいメッセージを入力
  　例：リビジョン番号#${IOS_DEPLOY_GATE_REVISION}
• If Build Failed：横の「+」ボタンをクリックするとビルド失敗時のメッセージを編集可(任意)

1.4 設定の確認

設定が完了したらCIをビルドしてSlack通知が送られてくるかを確認する

2. Circle CI(fastlane)

AndroidでDeployGateにアップロードするときはfastlaneから呼び出しています。
アップロード完了時はSharedValues::DEPLOYGATE_REVISIONにリビジョン番号が挿入されますのでこちらを参照します。
本来はfastlaneの戻り値を別の環境変数に保存して別のジョブでSlack通知をしたかったのですが、別のジョブで上書きした環境変数を保持する方法がわからなかったためfastlaneで通知をするように設定しました。
https://docs.fastlane.tools/actions/deploygate/

2.1 Webhook URLを環境変数に追加

Circle CI ログイン後、設定したいリポジトリをクリックして「Project Settings」をクリック
左側の「Environment Variables」をクリック
「Add Variable」をクリックして変数名と先程メモしたSlackのWebhook URLを入力
※今回は変数名をSLACK_WEBHOOK_URLとする

2.2 fastlaneの修正

プロジェクトのソースコードを修正する
プロジェクトファイル内のfastlane/Fastfileを開き、定数定義部分に以下の行を追加する

# 定数定義部分に追加
ENV["SLACK_URL"] = ENV['SLACK_WEBHOOK_URL']

そのままDeployGateアップロード処理の行の下に以下のコードを追加する
※Androidは失敗時の処理を追加していない　いずれ失敗時の分岐も追加する
参考：https://docs.fastlane.tools/actions/slack/

# DeployGateアップロード後の行に追加
android_version=lane_context[SharedValues::DEPLOYGATE_REVISION]
slack(
  message: "ケイト様ー！Androidの開発版アプリが##{android_version}としてアップロードされましたよー！",
  use_webhook_configured_username_and_icon: true
)

2.3 設定の確認

設定が完了したらCIをビルドしてSlack通知が送られてくるかを確認する

総括

これでどのプルリクエストの修正がどのDeployGateのリビジョンから反映されているかがわかりやすくなりました。
CIを触れるのが初めてだったこともあり、CIについても理解が深まったのでとても勉強になりました。

参考

SlackのWebhook URL取得手順
slackのIncoming webhookが新しくなっていたのでまとめてみた
envmanでBitriseの環境変数を上書きしようとしたら罠にハマった