GitLab for Slackアプリケーションの管理
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab Self-Managed、GitLab Dedicated
Slackアプリケーションディレクトリを通じて配布されるGitLab for Slackアプリケーションは、GitLab.comでのみ動作します。GitLab Self-Managedインスタンスでは、マニフェストファイルからGitLab for Slackアプリケーション独自のコピーを作成し、インスタンスを設定できます。
このアプリケーションは、Slackワークスペースにのみインストールされるプライベートな1回限りのコピーであり、Slackアプリケーションディレクトリを通じて配布されるものではありません。GitLab Self-ManagedインスタンスでGitLab for Slack appを使用するには、インテグレーションを有効にする必要があります。
Slackアプリケーションを作成する
前提条件:
- Slackワークスペース管理者以上である必要があります。
GitLab for Slackアプリケーションを作成するには:
GitLabの場合:
- 右上隅で、管理者を選択します。
- 左側のサイドバーで、設定 > 一般を選択します。
- GitLab for Slack appを展開します。
- Slackアプリを作成を選択します。
次の手順のためにSlackにリダイレクトされます。
In Slack:
- アプリケーションの作成先のSlackワークスペースを選択し、Nextを選択します。
- Slackにレビュー用のアプリケーションの概要が表示されます。マニフェスト全体を表示するには、Edit Configurationsを選択します。レビューの概要に戻るには、Nextを選択します。
- Createを選択します。
- 了解を選択してダイアログを閉じます。
- Install to Workspaceを選択します。
設定を設定する
GitLab for Slack appを作成したら、GitLabで設定を設定できます:
- 右上隅で、管理者を選択します。
- 設定 > 一般を選択します。
- GitLab for Slack appを展開します。
- SlackアプリのためにGitLabを有効にするチェックボックスを選択します。
- GitLab for Slackアプリケーションの詳細を入力します:
- Slack APIに移動します。
- **GitLab(
<your host name>)**を検索して選択します。 - App Credentialsまでスクロールします。
- 変更を保存を選択します。
GitLab for Slackアプリをインストールする
前提条件:
- Slackワークスペースにアプリを追加するための適切な権限が必要です。
- GitLab for Slack appを作成し、アプリの設定を設定する必要があります。
インスタンスの設定からGitLab for Slackアプリケーションをインストールするには:
- 右上隅で、管理者を選択します。
- 設定 > インテグレーションを選択します。
- GitLab for Slackアプリを選択します。
- GitLab for Slackアプリをインストールを選択します。
- Slackの確認ページで、許可を選択します。
構成をテストする
GitLab for Slackアプリケーションの構成をテストするには:
- Slackワークスペースのチャンネルに
/gitlab helpスラッシュコマンドを入力します。 - Enterキーを押します。
使用可能なスラッシュコマンドのリストが表示されます。
プロジェクトでスラッシュコマンドを使用するには、プロジェクトのGitLab for Slack appを設定します。
GitLab for Slackアプリケーションを更新する
前提条件:
- Slackワークスペース管理者以上である必要があります。
GitLabがGitLab for Slackアプリケーションの新機能をリリースすると、新しい機能を使用するために、コピーを手動で更新する必要がある場合があります。
GitLab for Slackアプリケーションのコピーを更新するには:
GitLabの場合:
- 右上隅で、管理者を選択します。
- 左側のサイドバーで、設定 > 一般を選択します。
- GitLab for Slack appを展開します。
slack_manifest.jsonをダウンロードするには、最新のマニフェストファイルをダウンロードを選択します。
In Slack:
- Slack APIに移動します。
- **GitLab(
<your host name>)**を検索して選択します。 - 左側のサイドバーで、App Manifestを選択します。
- マニフェストのJSONビューに切り替えるには、JSONタブを選択します。
- GitLabからダウンロードした
slack_manifest.jsonファイルの内容をコピーします。 - JSONビューアーに内容を貼り付けて、既存の内容を置き換えます。
- 変更を保存を選択します。
接続要件
GitLab for Slackアプリケーションの機能を有効にするには、ネットワークがGitLabとSlack間の受信接続と送信接続を許可する必要があります。
- Slack notificationsの場合、GitLabインスタンスは、
https://slack.comにリクエストを送信できる必要があります。 - Slash commandsおよびその他の機能の場合、GitLabインスタンスは、
https://slack.comからリクエストを受信できる必要があります。
複数のワークスペースのサポートを有効にする
デフォルトでは、1つのSlackワークスペースにのみGitLab for Slack appをインストールできます。管理者は、Slackアプリケーション用にGitLabを作成するときに、このワークスペースを選択します。
複数のSlackワークスペースのサポートを有効にするには、GitLab for Slackアプリケーションを非リリースの分散型アプリケーションとして設定する必要があります。非リリースの分散型アプリケーション:
- Slackアプリケーションディレクトリに公開されていません。
- お使いのGitLabインスタンスでのみ使用でき、他のサイトでは使用できません。
GitLab for Slackアプリケーションを非リリースの分散型アプリケーションとして設定するには:
- SlackのYour Appsページに移動し、GitLab for Slackアプリケーションを選択します。
- Manage Distributionを選択します。
- Share Your App with Other Workspacesセクションで、Remove Hard Coded Informationを展開します。
- I’ve reviewed and removed any hard-coded informationチェックボックスを選択します。
- 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との間でリクエストを許可している。