GitLab for Slackアプリの管理

Slack App Directoryから配布されたGitLab for Slackアプリは、GitLab.comでのみ動作します。Self-Managedインスタンスでは、マニフェストファイルからGitLab for Slackアプリの独自のコピーを作成し、インスタンスを設定できます。

このアプリは、Slackワークスペースにのみインストールされるプライベートな1回限りのコピーであり、Slack App Directoryからは配布されません。Self-ManagedインスタンスでGitLab for Slack appを使用するには、インテグレーションを有効にする必要があります。

GitLab for Slackアプリを作成する

前提要件:

• 少なくともSlackワークスペース管理者である必要があります。

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

• GitLab全体で:

  1. 左側のサイドバーの下部で、管理者を選択します。
  2. 左側のサイドバーで、設定 > 一般を選択します。
  3. GitLab for Slack appを展開します。
  4. Slackアプリを作成を選択します。

次の手順のためにSlackにリダイレクトされます。

• Slackで:

  1. アプリを作成するSlackワークスペースを選択し、次へを選択します。
  2. Slackは、レビュー用にアプリのサマリーを表示します。完全なマニフェストを表示するには、Edit Configurations（構成を編集）を選択します。レビューの概要に戻るには、次へを選択します。
  3. 作成を選択します。
  4. 了解を選択してダイアログを閉じます。
  5. Install to Workspace（ワークスペースにインストール）を選択します。

設定を構成する

GitLab for Slackアプリを作成した後、GitLabで設定を構成できます:

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > 一般を選択します。
3. GitLab for Slack appを展開します。
4. SlackアプリのためにGitLabを有効にするチェックボックスを選択します。
5. GitLab for Slackアプリの詳細を入力します:
   1. Slack APIにアクセスします。
   2. GitLab ()（GitLab（<ホスト名>））を検索して選択します。
   3. App Credentials（アプリの認証情報）までスクロールします。
6. 変更を保存を選択します。

設定をテストします

GitLab for Slackアプリの設定をテストするには:

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

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

プロジェクトでスラッシュコマンドを使用するには、プロジェクトのGitLab for Slack appを構成します。

GitLab for Slackアプリをインストールする

前提要件:

• Slackワークスペースにアプリを追加するための適切な権限が必要です。
• GitLab for Slackアプリを作成し、アプリの設定を構成する必要があります。

インスタンス設定からGitLab for Slackアプリをインストールするには:

1. 左側のサイドバーの下部で、管理者を選択します。
2. 設定 > インテグレーションを選択します。
3. GitLab for Slack appを選択します。
4. Slackアプリ用GitLabをインストールを選択します。
5. Slackの確認ページで、許可を選択します。

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

前提要件:

• 少なくともSlackワークスペース管理者である必要があります。

GitLabがGitLab for Slackアプリの新しいリリースをリリースすると、新しい機能を使用するためにコピーを手動で更新する必要がある場合があります。

GitLab for Slackアプリのコピーを更新するには:

• GitLab全体で:

  1. 左側のサイドバーの下部で、管理者を選択します。
  2. 左側のサイドバーで、設定 > 一般を選択します。
  3. GitLab for Slack appを展開します。
  4. slack_manifest.jsonをダウンロードするには、最新のマニフェストファイルをダウンロードを選択します。

• Slackで:

  1. Slack APIにアクセスします。
  2. GitLab ()（GitLab（<ホスト名>））を検索して選択します。
  3. 左側のサイドバーで、App Manifestを選択します。
  4. JSONタブを選択して、マニフェストのJSONビューにスイッチします。
  5. GitLabからダウンロードしたslack_manifest.jsonファイルの内容をコピーします。
  6. 既存のコンテンツを置き換えるために、コンテンツをJSONビューアに貼り付けます。
  7. 変更を保存を選択します。

接続要件

GitLab for Slackアプリの機能を有効にするには、ネットワーキングでGitLabとSlack間の受信および送信接続を許可する必要があります。

• Slack通知の場合、GitLabインスタンスはhttps://slack.comにリクエストを送信できる必要があります。
• スラッシュコマンドおよびその他の機能の場合、GitLabインスタンスはhttps://slack.comからリクエストを受信できる必要があります。

複数のワークスペースのサポートを有効にする

デフォルトでは、1つのSlackワークスペースにのみGitLab for Slackアプリをインストールできます。管理者は、GitLab for Slackアプリを作成するときに、このワークスペースを選択します。

複数のSlackワークスペースのサポートを有効にするには、GitLab for Slackアプリを非掲載の分散アプリとして設定する必要があります。非掲載の分散アプリ:

• Slack App Directoryに公開されていません。
• 他のサイトではなく、GitLabインスタンスでのみ使用できます。

GitLab for Slackアプリを非掲載の分散アプリとして設定するには:

1. SlackのYour Appsページにアクセスし、GitLab for Slackアプリを選択します。
2. Manage Distributionを選択します。
3. Share Your App with Other Workspacesセクションで、Remove Hard Coded Informationを展開します。
4. I’ve reviewed and removed any hard-coded informationチェックボックスを選択します。
5. Activate Public Distributionを選択します。

トラブルシューティング

GitLab for Slackアプリを管理する場合、次のイシューが発生する可能性があります。

ユーザー向けドキュメントは、GitLab for Slack appを参照してください。

スラッシュコマンドがSlackでdispatch_failedを返す

スラッシュコマンドは、Slackで/gitlab failed with the error "dispatch_failed"を返す場合があります。

この問題を解決するには、以下を確認してください:

• GitLab for Slackアプリが適切に設定されており、SlackアプリのためにGitLabを有効にするチェックボックスが選択されている。
• GitLabインスタンスがSlackとの間でリクエストを許可しています。