Mattermostのスラッシュコマンド
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
スラッシュコマンドを使用して、Mattermostチャット環境からイシューの作成など、一般的なGitLab操作を実行できます。
GitLabは、個別に設定されたMattermost通知の一部として、(issue createdなど)のイベントをMattermostに送信することもできます。
利用可能なスラッシュコマンドの一覧については、スラッシュコマンドを参照してください。
設定オプション
GitLabでは、Mattermostのスラッシュコマンドを設定するさまざまな方法が用意されています。これらのオプションのいずれかを使用するには、Mattermost 3.4以降が必要です。
- Linuxパッケージインストール: MattermostはLinuxパッケージにバンドルされています。LinuxパッケージインストールのMattermostを設定するには、LinuxパッケージMattermostドキュメントをお読みください。
- MattermostがGitLabと同じサーバーにインストールされている場合: 自動設定を使用します。
- その他すべてのインストールのmanual configuration: 手動設定を使用します。
自動設定
MattermostがGitLabと同じサーバーにインストールされている場合は、Mattermostスラッシュコマンドを自動的に設定できます:
- 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
- 設定 > インテグレーションを選択します。
- Mattermostスラッシュコマンドを選択します。
- インテグレーションを有効にするで、有効チェックボックスがオンになっていることを確認します。
- Mattermostに追加を選択し、変更を保存を選択します。
手動設定
Mattermostでスラッシュコマンドを手動で設定するには、次の手順を実行する必要があります:
- Mattermostでカスタムスラッシュコマンドを有効にする。この手順は、セルフコンパイルインストールの場合にのみ必要です。
- GitLabから設定値を取得。
- Mattermostでスラッシュコマンドを作成。
- MattermostトークンをGitLabに提供。
Mattermostでカスタムスラッシュコマンドを有効にする
Mattermost管理者コンソールからカスタムスラッシュコマンドを有効にするには:
- 管理者権限を持つユーザー名としてMattermostにサインインします。
- ユーザー名の横にある 設定アイコンを選択し、System Console(システムコンソール)を選択します。
- Integration Management(インテグレーション管理)を選択し、これらの値を
TRUEに設定します:- Enable Custom Slash Commands(カスタムスラッシュコマンドを有効にする)
- Enable integrations to override usernames(インテグレーションでユーザー名をオーバーライドできるようにする)
- Enable integrations to override profile picture icons(インテグレーションでプロフィール画像のアイコンをオーバーライドできるようにする)
- 保存を選択しますが、このブラウザータブは閉じないでください。これは後のステップで必要になります。
GitLabから設定値を取得
GitLabから設定値を取得するには:
- 別のブラウザータブで、管理者アクセス権を持つユーザー名としてGitLabにサインインします。
- 左側のサイドバーの下部で、管理者を選択します。
- 設定 > インテグレーションを選択します。
- Mattermostスラッシュコマンドを選択します。GitLabに、Mattermost設定の候補の値が表示されます。
- リクエストURLの値をコピーします。その他すべての値は提案です。
- このブラウザータブを閉じないでください。これは後のステップで必要になります。
Mattermostでスラッシュコマンドを作成
Mattermostでスラッシュコマンドを作成するには:
Mattermostブラウザータブで、チームページに移動します。
設定アイコンを選択し、インテグレーションを選択します。
左側のサイドバーで、Slash commands(スラッシュコマンド)を選択します。
Add Slash Command(スラッシュコマンドを追加)を選択します。
新しいコマンドのDisplay Name(表示名)と説明を入力します。
アプリケーションの設定に基づいてCommand Trigger Word(コマンドトリガーワード)を指定します:
- 1つのGitLabプロジェクトのみをMattermostチームに接続する場合は、
/gitlabをトリガーワードに使用します。 - 複数のGitLabプロジェクトを接続する場合は、
/project-nameや/gitlab-project-nameなど、GitLabプロジェクトに関連するトリガーワードを使用します。
- 1つのGitLabプロジェクトのみをMattermostチームに接続する場合は、
リクエストURLには、GitLabからコピーした値を貼り付けます。
その他すべての値については、GitLabからの提案値または推奨値を使用できます。
パイプライントークンの値をコピーして、完了を選択します。
MattermostトークンをGitLabに提供
Mattermostでスラッシュコマンドを作成すると、GitLabに提供する必要があるトークンが生成されます:
- GitLabブラウザータブで、有効チェックボックスをオンにします。
- パイプライントークンテキストボックスに、Mattermostからコピーしたトークンを貼り付けます。
- 変更を保存を選択します。
スラッシュコマンドがGitLabプロジェクトと通信できるようになりました。
GitLabアカウントをMattermostに接続
前提要件:
Mattermostスラッシュコマンドを使用してGitLabとやり取りするには:
- Mattermostのチャット環境で、新しいスラッシュコマンドを実行します。
- connect your GitLab account(GitLabアカウントを接続する)を選択して、アクセスを承認します。
承認されたすべてのチャットアカウントは、Mattermostのプロファイルページのチャットに表示されます。
関連トピック
トラブルシューティング
MattermostスラッシュコマンドがGitLabでイベントをトリガーしない場合:
- パブリックチャンネルを使用していることを確認してください。Mattermost Webhookは、プライベートチャンネルにアクセスできません。
- プライベートチャンネルが必要な場合は、Webhookチャンネルを編集し、プライベートなチャンネルを1つ選択します。すべてのイベントは、指定されたチャンネルに送信されます。