Slackアプリ管理のためのGitLab

GitLab 16.2でセルフマネージドインスタンスに導入されました。

note
このページには、セルフマネージドインスタンス用のGitLab for Slackアプリの管理に関する情報が含まれています。ユーザードキュメントはGitLab for Slack appをご覧ください。

Slack App Directoryを通じてディストリビューションされたGitLab for SlackアプリはGitLab.comでのみ動作します。セルフマネージドGitLabでは、マニフェストファイルからGitLab for Slackアプリの独自のコピーを作成し、インスタンスを設定することができます。

アプリはあなたのSlackワークスペースにのみインストールされる非公開の1回限りのコピーであり、Slack App Directoryを通じてディストリビューションされることはありません。GitLab for Slackアプリをセルフマネージドインスタンスにインストールするには、インテグレーションを有効にする必要があります。

GitLab for Slackアプリの作成

前提条件

GitLab for Slackアプリを作成するには：

  • GitLab：

    1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
    2. Admin Areaを選択します。
    3. 左サイドバーで、設定 > 一般を選択します。
    4. GitLab for Slackアプリを展開します。
    5. Create Slack appを選択します。

次のステップのためにSlackにリダイレクトされます。

  • Slackで

    1. アプリを作成するSlackワークスペースを選択し、「Next」を選択します。
    2. レビュアー用にアプリの概要が表示されます。完全なマニフェストを表示するには、[設定の編集] を選択します。レビュー概要に戻るには、[次へ] を選択します。
    3. 作成を選択します。
    4. Got itを選択してダイアログを閉じます。
    5. ワークスペースにインストールを選択します。

設定の構成

GitLab for Slackアプリを作成したら、GitLabで設定を行います：

  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 左サイドバーで、設定 > 一般を選択します。
  4. GitLab for Slackアプリを展開します。
  5. Enable GitLab for Slack appチェックボックスを選択します。
  6. GitLab for Slackアプリの詳細を入力します：
    1. Slack APIにアクセスしてください。
    2. GitLab (<your host name>) を検索して選択します。
    3. App Credentials までスクロールします。
  7. 変更を保存を選択します。

設定のテスト

GitLab for Slack アプリの設定をテストします：

  1. /gitlab help スラッシュコマンドを Slack ワークスペースのチャンネルに入力してください。
  2. Enterを押します。

利用可能なSlashコマンドのリストが表示されます。

プロジェクトで Slash コマンドを使うには、GitLab for Slack アプリを設定します。

GitLab for Slackアプリをアップデートします。

前提条件

GitLabがGitLab for Slackアプリの新機能をリリースした場合、新機能を使うために手動でアップデートする必要があるかもしれません。

GitLab for Slackアプリをアップデートするには：

  • GitLab：

    1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
    2. Admin Areaを選択します。
    3. 左サイドバーで、設定 > 一般を選択します。
    4. GitLab for Slackアプリを展開します。
    5. 最新のマニフェストファイルをダウンロード]を選択し、slack_manifest.jsonをダウンロードします。

  • Slackで

    1. Slack APIにアクセスしてください。
    2. GitLab (<your host name>) を検索して選択します。
    3. 左側のサイドバーで、アプリマニフェストを選択します。
    4. JSON]タブを選択して、マニフェストの JSON ビューに切り替えます。
    5. GitLab からダウンロードしたslack_manifest.json ファイルの内部をコピーします。
    6. その内容をJSONビューアに貼り付け、既存の内容を置き換えます。
    7. 変更を保存を選択します。

接続要件

GitLab for Slackアプリの機能を有効にするには、ネットワークがGitLabとSlack間のインバウンドおよびアウトバウンド接続を許可している必要があります。

  • Slackの通知のためには、GitLabインスタンスがhttps://slack.comにリクエストを送信できる必要があります。
  • Slashコマンドやその他の機能を使うには、GitLabインスタンスがhttps://slack.comからのリクエストを受け取れる必要があります。

トラブルシューティング

スラッシュコマンドは Slack で/gitlab failed with the error "dispatch_failed" を返します。

スラッシュコマンドがSlackで/gitlab failed with the error "dispatch_failed" 。このイシューを解決するには、以下を確認してください：