【GitLab 16.5】セルフマネージメント環境にてSlack通知(Slack app)を有効にする方法

GitLabのSlack notificationsがバージョン15.9から非推奨(Deprecated)となり、代わりにSlack appを利用を推奨されています。本記事ではセルフマネージメント環境にてSlack appを有効にする方法を紹介します。

以前の「Slack notifications」より設定する手順が多くなりました。。。

次のように今までの「Slack notifications」を追加すると非推奨(Deprecated)の警告が表示されます。

公式サイトからの引用

This feature was deprecated in GitLab 15.9 and is planned for removal in 17.0. Use the GitLab for Slack app instead. This change is a breaking change. For the planned support of the GitLab for Slack app for self-managed instances, see epic 1211.

https://docs.gitlab.com/ee/user/project/integrations/slack.html

なので今回はSlack appを利用してSlack通知を有効にします。

環境

今回は次の環境で検証を行いました。

  • GitLab 16.5.0(on Kubernetes)
CAUTION

今回のSlack appはGitLab16.2以上のバージョンが対象です。

GitLab用のSlack Appの作成

まずGitLab用のSlack Appを作成します。管理者権限のユーザでGitLabにログインし、Admin AreaのSettingsのGeneralへアクセスし、一番下にある「GitLab for Slack app」の「Expand」ボタンをクリックします。

「Create Slack app」ボタンをクリックします。

slack apiのWebページに遷移し「Pick a workspace to develop your app in:」のダイアログが表示されています。Slack Appを追加したいSlackワークスペースを選択し「Next」ボタンをクリックします。

確認画面が表示されますので「Create」ボタンをクリックします。

Slack Appが作成されます。初期表示で説明用の吹き出しが表示されますので「Got it」ボタンをクリックします。

Slack AppをSlackワークスペースにインストール

作成したGitLabのSlack AppをSlackワークスペースにインストールします。「Install to Workspace」ボタンをクリックします。

権限リクエストの画面が表示されますので「許可する」ボタンをクリックします。

これでSlack AppがSlackワークスペースにインストールされます。

Slack Appの設定内容をGitLabに反映

Slack Appの設定内容をGitLabに反映させます。https://api.slack.com/appsにアクセスします。

「Your Apps」画面が表示されます。「I Agree」ボタンをクリックしておきます。

作成したGitLabのアプリを選択します。

表示されたページには次の設定情報が表示されます。

  • Client ID
  • Client Secret
  • Signing Secret
  • Verification Token

上記の内容をコピーして先ほど表示したGitLabのSlack Appの設定画面(Admin Area -> General -> GitLab for Slack app)にて入力します。

これでSlack Appの設定内容をGitLabに反映させることができました。

GitLabにてSlack通知の設定

GitLabにてSlack通知の設定を行います。GitLabの管理者権限のユーザでログインし「Admin Area -> Settings -> Integrations」へアクセスし「GitLab for Slack app」の「Configure」ボタンをクリックします。

次の画面で「Install GitLab for Slack app…」ボタンをクリックします。

slackのWebページに遷移し、権限リクエストの画面が表示されますので「許可する」ボタンをクリックします。

GitLabのページにリダイレクトされ、次のように表示されれば、GitLab for Slack Appのインストールが完了します。

Triggerの設定にて各イベント毎に通知したいSlackのチェンネル名を指定します。

「Save Changes」ボタンをクリックします。

これでGitLabのイベントがSlackに通知されるようになります。

動作確認

次のようにGitLabのプロジェクトでCICDパイプラインの実行結果などがSlackに通知されます。

これで今回のSlack appの設定は完了です。お疲れ様でした。

参考

https://docs.gitlab.com/ee/administration/settings/slack_app.html

コメントを残す

マークダウン形式でコメントを入力できます。

アップロードファイルの最大サイズ: 512 MB。 画像, 音声, 動画, 文書, スプレッドシート, 対話型, テキスト, アーカイブ, コード, その他 をアップロードできます。 Youtube、Facebook、Twitter および他サービスへのリンクは自動的にコメント内に埋め込まれます。 ここにファイルをドロップ

プロフィール背景
Ryosuke
Ryosuke

ITエンジニア & 講師

クラウドネイティブやアーキテクチャ設計の講師として活動しながら、ITエンジニアのDXを推進するために新しい技術やベストプラクティスを常に学び、エンジニアの生産性と開発品質の向上に貢献することを目指しています。猫5匹飼っています。山奥のポツンと一軒家に住んでいて、事務所は海の近くです。