レビュー依頼・承認のSlack連携
レビュー設定を使ったアクションのレビュー依頼を、SlackのDMとSlackアプリのホームタブで受け取り、Slack上で承認・却下まで完結できる機能です。
これまでレビュー依頼の確認・承認は、承認者がベースマキナのWeb画面を開いて行なう必要がありました。この機能を使うと、承認者は自分宛てのレビュー依頼をSlackで受け取り、そのまま承認・却下できます。Slackとの連携は次の2つで構成されます。
- DM通知: レビュー依頼の作成・リマインド・承認・却下のタイミングで、対象のユーザーにSlackのDMが届きます。
- ホームタブ: Slackアプリのホームタブで、自分宛てのレビュー依頼と自分が出したレビュー依頼を一覧で確認できます。
前提条件
この機能を利用するには、以下の設定が必要です。
- Slackワークスペースとの連携: 企業アカウントとSlackワークスペースが連携されている必要があります。連携の手順はSlack連携を参照してください。
- ユーザーとSlackアカウントの紐づけ: 承認者・依頼者のベースマキナユーザーとSlackアカウントがメールアドレスで紐づいている必要があります。紐づけはSlack連携時に自動で行なわれます。
- Slackプロフィールでのメールアドレス公開: Slackプロフィールでメールアドレスが非公開になっていると、ベースマキナユーザーを特定できず利用できません。
レビュー依頼のDM通知
レビュー依頼に関する以下のイベントが発生すると、対象のユーザーにSlackのDMが届きます。
| 種別 | 通知タイミング | 宛先 | 主な内容 | ボタン |
|---|---|---|---|---|
| 依頼到着 | レビュー依頼の作成時 | 対象の全レビュアー | ホームタブの「承認待ち」と同じカード(アクション名・依頼者・依頼日時・期限・実行引数など) | 承認・却下 |
| リマインド | 期限が近づいたとき | まだ承認していないレビュアー | ホームタブの「承認待ち」と同じカード(アクション名・依頼者・依頼日時・期限・実行引数など) | 承認・却下 |
| 承認 | レビューが承認されたとき | 依頼者 | 承認者・アクション名・プロジェクト名 / 環境名 | 詳細を開く |
| 却下 | レビューが却下されたとき | 依頼者 | 却下者・却下理由・アクション名・プロジェクト名 / 環境名 | 詳細を開く |
- 「依頼到着」「リマインド」のDMにある「承認」「却下」ボタンを選択すると、後述のホームタブと同じ承認・却下の画面が開き、そのまま処理できます。
- 「承認」「却下」のDMにある「詳細を開く」を選択すると、Web画面の該当レビュー依頼が開きます。
ホームタブで表示される内容
承認者がSlackアプリのホームタブを開くと、その人がアクセスできるプロジェクト・環境のレビュー依頼が表示されます。「承認待ち」「自分が出したレビュー依頼」の2つのタブを上部のボタンで切り替えて確認できます。どちらのタブも、依頼はプロジェクト・環境ごとにまとめて表示されます。
承認待ち
自分がレビュアーとして設定されているレビュー依頼が表示されます。各レビュー依頼のカードには以下が表示されます。
- アクション名(Web画面の該当レビュー依頼へのリンク)
- プロジェクト名 / 環境名
- 依頼者
- 依頼日時
- 期限
- アクションの実行引数(引数名と値)
- ユーザーグループの承認状況(承認条件にユーザーグループを設定している場合)
- 「承認」「却下」ボタン
自分が出したレビュー依頼
自分が依頼したレビュー依頼のうち、まだ承認・却下されていない確認中のものが一覧で表示されます。
表示されるのは、ログイン中のSlackユーザーに紐づくベースマキナユーザーがアクセスできるプロジェクト・環境のレビュー依頼のみです。各タブとも最大20件まで表示されます。すべてを確認するには、各プロジェクト・環境の「プロジェクト名 / 環境名」のリンクからWeb画面のレビュー依頼一覧を開いてください。
レビューを承認・却下する
- DMまたはホームタブの「承認待ち」から、対象のレビュー依頼の「承認」または「却下」ボタンを選択します。
- コメント入力用の画面が開きます。
- 承認: コメントの入力は任意です。
- 却下: 却下理由のコメント入力が必須です。
- 「承認する」または「却下する」を選択すると、レビュー依頼が処理されます。
承認・却下が完了すると、ホームタブの「承認待ち」から該当のレビュー依頼が消えます。
すでに承認・却下されたレビュー依頼を再度処理しようとすると、処理済みである旨のメッセージが表示されます。
レビュー依頼の詳細を確認したい場合は、カードのアクション名を選択するとWeb画面の該当レビュー依頼が開きます。
必要な権限
- Slack上でのレビュー承認・却下: Slackで承認・却下できるのは、対象のレビュー設定でレビュアーとして設定されたユーザーです。Web画面での承認と同じ権限で動作します。
- Slackワークスペースの連携設定: 連携の設定には企業アカウントの管理者権限が必要です。
必要なSlackアプリ権限
この機能では、Slack連携で使用する権限に加えて、以下の権限を使用します。
chat:write(opens in a new tab) /im:write(opens in a new tab): レビュアー・依頼者へのDM送信に使用します。app_home:write(opens in a new tab): ホームタブの表示更新に使用します。
うまく表示されないとき
ホームタブでレビュー依頼を確認できないときは、表示される案内に応じて以下を確認してください。
| 状況 | 原因と対処 |
|---|---|
| Slackのメールアドレスを取得できない | Slackプロフィールでメールアドレスが非公開になっています。プロフィール設定でメールアドレスを公開してください。 |
| メールアドレスに紐づくユーザーが見つからない | Slackのメールアドレスに紐づくベースマキナユーザーが存在しません。別のメールアドレスで登録している場合は、Slackプロフィールのメールアドレスを合わせるか、管理者にアカウント作成を依頼してください。 |
| ワークスペースが連携されていない | 企業アカウントの管理者がSlack連携を設定していません。Slack連携を設定してください。 |