amplify-category-console-notificationでAmplify ConsoleのSlackアプリを追加する

Amplify Console の Slack アプリ

Amplify Console のビルト結果を Slack に通知する Amplify プラグインとしてamplify-category-console-notificationを公開しています。 最近、このプラグインに Slack アプリを追加しました。

amplify-category-console-notificationの Slack アプリを追加すると次のことができるようになります。

  • Amplify Console のビルド開始・終了時に Slack メッセージで通知を受け取る
  • Slack メッセージからそのバージョンを再デプロイする
  • Slack メッセージから Amplify Console のビルドをキャンセルする

Slackに通知されるメッセージ Slack に通知されたビルド結果

この Slack アプリを追加する以前は、Slack の Incoming Webhook（以降、Webhook 版）を利用して Slack にビルド結果のメッセージを送信していました。 Webhook 版はシンプルな構成でビルド結果の通知ができていましが、ビルドに対するアクションも Slack 上からできると便利だと思い、Slack アプリ版を追加しました1。

Slack アプリを追加する

Slack アプリを追加（利用）するには、Amplify プロジェクトで次のコマンドを実行してamplify-category-console-notificationをインストールします。

npm install -g amplify-category-console-notification amplify-slack-nodejs-function-template-provider
amplify plugin add $(npm root -g)/amplify-category-console-notification

インストールできたら、以下のコマンドで Slack アプリ追加を開始します。

amplify add console-notification

コマンドを実行すると、Webhook 版と Slack アプリ版のどちらを使うのか聞かれるので Slack アプリを選択します。 Slack アプリを選択すると、Slack アプリを追加するの必要な手順がコンソールに表示されます。スクリーンキャプチャ付きのドキュメントの URL がコンソールに表示され、ブラウザでそのページが表示されるので、その手順に沿って Slack API のページで Slack App を作成してください。実際の手順はこちらから確認できます。

Slackアプリ追加 コンソールに表示された Slack アプリを追加するの必要な手順

Slack App を作成すると、Slack API のページで以下の値を確認できるようになります。コンソールのプロンプトでそれらの値の入力を求められるので入力してください2。

  • Signing Secret
  • Slack Bot User OAuth Token
  • Slack Channel ID

全て入力が完了したら、追加されたサービスのリソースを AWS 上に作成します。 amplify pushするか、すでに Amplify Console と連携済みであればgit commit＆git pushをすることで実行できます。 これ以降は、Amplify Console でビルドする度に、Slack に通知のメッセージが送信されるようになります。

フィードバックのお願い

Amplify ユーザーの方に使っていただいてフィードバックをいただけると嬉しいです。バグ報告や改善提案などGitHub の Issue、Twitter、Amplify Japan User Group の Slackなどでお待ちしています。

Footnotes

  1. Slack アプリ版を追加しましたが、Incoming Webhook 版も引き続き利用可能です。 ↩

  2. 入力されたシークレット、トークンは AWS SSM に保存されます。 ↩