GitLab for Slackアプリの管理

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

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

GitLab for Slackアプリを作成する

前提条件:

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

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

• GitLabで、次の手順に従います:

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

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

• Slackで、次の手順に従います:

  1. アプリを作成するSlackワークスペースを選択し、Nextを選択します。
  2. Slackに確認用のアプリの概要が表示されます。マニフェスト全体を確認するには、Edit Configurationsを選択します。確認用の概要に戻るには、Nextを選択します。
  3. Createを選択します。
  4. ダイアログを閉じるためにGot itを選択します。
  5. Install to Workspaceを選択します。

設定する

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

1. 右上隅で、管理者を選択します。
2. 設定 > 一般を選択します。
3. GitLab for Slackアプリを展開します。
4. GitLab for Slackを有効にするチェックボックスをオンにします。
5. GitLab for Slackアプリの詳細を入力します:
   1. Slack APIに移動します。
   2. **GitLab（<your host name>）**を検索して選択します。
   3. アプリの認証情報までスクロールします。
6. 変更を保存を選択します。

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

前提条件:

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

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

1. 右上隅で、管理者を選択します。
2. 設定 > インテグレーションを選択します。
3. GitLab for Slackアプリを選択します。
4. GitLab for Slackアプリをインストールを選択します。
5. Slackの確認ページで、許可を選択します。

設定をテストする

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

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

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

プロジェクトでスラッシュコマンドを使用するには、そのプロジェクト向けにGitLab for Slackアプリを設定します。

GitLab for Slackアプリを更新する

前提条件:

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

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

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

• GitLabで、次の手順に従います:

  1. 右上隅で、管理者を選択します。
  2. 左側のサイドバーで、設定 > 一般を選択します。
  3. GitLab for Slackアプリを展開します。
  4. 最新のマニフェストファイルをダウンロードを選択して、slack_manifest.jsonをダウンロードします。

• Slackで、次の手順に従います:

  1. Slack APIに移動します。
  2. **GitLab（<your host name>）**を検索して選択します。
  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からのリクエストを受信できる必要があります。

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

デフォルトでは、GitLab for Slackアプリをインストールできるのは1つの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アプリを参照してください。

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

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

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

• GitLab for Slackアプリが適切に設定され、GitLab for Slackアプリを有効にするチェックボックスがオンになっている。
• GitLabインスタンスがSlackとの間でリクエストの送受信を許可している。