Mattermostスラッシュコマンド
スラッシュコマンドを使えば、イシューの作成など GitLab の一般的なオペレーションをMattermost のチャット環境から実行できます。
GitLab は、個別に設定されたMattermost の通知の一部として、イベント (issue created
など) を Mattermost に送信することもできます。
利用可能なスラッシュコマンドの一覧は、スラッシュコマンドを参照してください。
設定オプション
GitLab は Mattermost スラッシュコマンドを設定する様々な方法を提供します。これらのオプションのいずれについても、Mattermost3.4 以降が必要です。
- Linux パッケージのインストール:Mattermost はLinux パッケージにバンドルされています。Linux パッケージインストール用に Mattermost を設定するには、Linux パッケージ Mattermost ドキュメントをお読みください。
- Mattermost が GitLab と同じサーバーにインストールされている場合は、自動設定を使用してください。
- それ以外のインストールの場合は、手動設定を使用してください。
自動設定
Mattermost が GitLab と同じサーバーにインストールされている場合、Mattermost のスラッシュコマンドを自動的に設定することができます:
- 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
- 設定]>[インテグレーション]を選択します。
- Mattermost のスラッシュコマンドを選択します。
- インテグレーションを有効にする] で、[アクティブ] チェックボックスが選択されていることを確認します。
- Add to Mattermost] を選択し、[Save changes] を選択します。
手動設定
Mattermost でスラッシュコマンドを手動で設定するには、以下の手順が必要です:
- Mattermost でカスタムスラッシュコマンドを有効にします。このステップは、セルフコンパイル・インストールにのみ必要です。
- GitLab から設定値を取得します。
- Mattermost でスラッシュコマンドを作成します。
- GitLab に Mattermost トークンを提供します。
Mattermost でカスタムスラッシュコマンドを有効化
Mattermost 管理者コンソールからカスタムスラッシュコマンドを有効にするには、以下の手順に従います:
- 管理者権限を持つユーザーとして Mattermost にサインインします。
- ユーザー名の横にある 設定アイコンを選択し、システムコンソールを選択します。
-
インテグレーション管理]を選択し、これらの値を
TRUE
に設定します:- カスタムスラッシュコマンドの有効化
- ユーザー名を上書きするインテグレーションを有効にします。
- プロフィール画像アイコンを上書きするインテグレーションを有効にします。
- 保存を選択しますが、このブラウザタブは閉じないでください。後のステップで必要になります。
GitLab から設定値を取得します。
GitLab から設定値を取得するには、次のようにします:
- 別のブラウザタブで、管理者権限を持つユーザーとしてGitLabにサインインします。
- 左のサイドバーで、Search を選択するか、次のページに進んでください。
- Admin Areaを選択します。
- 設定]>[インテグレーション]を選択します。
- Mattermost のスラッシュコマンドを選択します。GitLab は Mattermost 設定の潜在的な値を表示します。
- Request URLの値をコピーします。他の値はすべて候補です。
- このブラウザのタブは閉じないでください。後のステップで必要になります。
Mattermost でスラッシュコマンドを作成します。
Mattermost でスラッシュコマンドを作成します:
- Mattermost ブラウザタブで、チームページに移動します。
- ellipsis_v} 設定アイコンを選択し、インテグレーションを選択します。
- 左サイドバーでSlashコマンドを選択します。
- スラッシュコマンドを追加]を選択します。
- 新しいコマンドの表示名と 説明を入力します。
-
アプリケーションの設定に基づいて、コマンド・トリガー・ワードを指定します:
-
つのプロジェクトだけを Mattermost チームに接続する場合は、トリガーワードに
/gitlab
を使用してください。 -
複数のプロジェクトを接続する場合は、
/project-name
や/gitlab-project-name
など、プロジェクトに関連するトリガーワードを使用してください。
-
つのプロジェクトだけを Mattermost チームに接続する場合は、トリガーワードに
- リクエストURLには、GitLabからコピーした値を貼り付けます。
- その他の値については、GitLabからの提案やお好みの値を使うことができます。
- Tokenの値をコピーし、Done を選択します。
GitLab に Mattermost トークンを提供します。
Mattermost でスラッシュコマンドを作成すると、GitLab に提供しなければならないトークンが生成されます:
- GitLab ブラウザータブで、アクティブチェックボックスを選択します。
- Tokenテキストボックスに、Mattermost からコピーしたトークンを貼り付けます。
- 変更を保存を選択します。
これで、slash コマンドが GitLab プロジェクトと通信できるようになりました。
GitLab アカウントを Mattermost に接続しましょう。
前提条件
- スラッシュコマンドを実行するには、GitLabプロジェクトでアクションを実行する権限が必要です。
Mattermost スラッシュコマンドを使って GitLab とやり取りするには:
- Mattermost チャット環境で、新しいスラッシュコマンドを実行します。
- connect your GitLab accountto authorize access を選択します。
認証されたチャットアカウントは、Mattermost のプロフィールページのChat で確認できます。
関連するトピック
トラブルシューティング
Mattermost のスラッシュコマンドが GitLab でイベントをトリガーしない場合:
- 公開チャンネルを使用していることを確認してください。Mattermost Webhook は非公開チャンネルにアクセスできません。
- 非公開チャンネルが必要な場合は、Webhook チャンネルを編集し、非公開チャンネルを選択してください。すべてのイベントは指定したチャンネルに送信されます。