Mattermostスラッシュコマンド

スラッシュコマンドを使えば、イシューの作成など GitLab の一般的なオペレーションをMattermost のチャット環境から実行できます。

GitLab は、個別に設定されたMattermost の通知の一部として、イベント (issue createdなど) を Mattermost に送信することもできます。

利用可能なスラッシュコマンドの一覧は、スラッシュコマンドを参照してください。

設定オプション

GitLab は Mattermost スラッシュコマンドを設定する様々な方法を提供します。これらのオプションのいずれについても、Mattermost3.4 以降が必要です。

自動設定

Mattermost が GitLab と同じサーバーにインストールされている場合、Mattermost のスラッシュコマンドを自動的に設定することができます:

  1. 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
  2. 設定]>[インテグレーション]を選択します。
  3. Mattermost のスラッシュコマンドを選択します。
  4. インテグレーションを有効にする] で、[アクティブ] チェックボックスが選択されていることを確認します。
  5. Add to Mattermost] を選択し、[Save changes] を選択します。

手動設定

Mattermost でスラッシュコマンドを手動で設定するには、以下の手順が必要です:

  1. Mattermost でカスタムスラッシュコマンドを有効にします。このステップは、セルフコンパイル・インストールにのみ必要です。
  2. GitLab から設定値を取得します。
  3. Mattermost でスラッシュコマンドを作成します。
  4. GitLab に Mattermost トークンを提供します。

Mattermost でカスタムスラッシュコマンドを有効化

Mattermost 管理者コンソールからカスタムスラッシュコマンドを有効にするには、以下の手順に従います:

  1. 管理者権限を持つユーザーとして Mattermost にサインインします。
  2. ユーザー名の横にある 設定アイコンを選択し、システムコンソールを選択します。
  3. インテグレーション管理]を選択し、これらの値をTRUE に設定します:
    • カスタムスラッシュコマンドの有効化
    • ユーザー名を上書きするインテグレーションを有効にします。
    • プロフィール画像アイコンを上書きするインテグレーションを有効にします。
  4. 保存を選択しますが、このブラウザタブは閉じないでください。後のステップで必要になります。

GitLab から設定値を取得します。

GitLab から設定値を取得するには、次のようにします:

  1. 別のブラウザタブで、管理者権限を持つユーザーとしてGitLabにサインインします。
  2. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  3. Admin Areaを選択します。
  4. 設定]>[インテグレーション]を選択します。
  5. Mattermost のスラッシュコマンドを選択します。GitLab は Mattermost 設定の潜在的な値を表示します。
  6. Request URLの値をコピーします。他の値はすべて候補です。
  7. このブラウザのタブは閉じないでください。後のステップで必要になります。

Mattermost でスラッシュコマンドを作成します。

Mattermost でスラッシュコマンドを作成します:

  1. Mattermost ブラウザタブで、チームページに移動します。
  2. ellipsis_v} 設定アイコンを選択し、インテグレーションを選択します。
  3. 左サイドバーでSlashコマンドを選択します。
  4. スラッシュコマンドを追加]を選択します。
  5. 新しいコマンドの表示名と 説明を入力します。
  6. アプリケーションの設定に基づいて、コマンド・トリガー・ワードを指定します:

    • つのプロジェクトだけを Mattermost チームに接続する場合は、トリガーワードに/gitlab を使用してください。
    • 複数のプロジェクトを接続する場合は、/project-name/gitlab-project-nameなど、プロジェクトに関連するトリガーワードを使用してください。
  7. リクエストURLにはGitLabからコピーした値を貼り付けます。
  8. その他の値については、GitLabからの提案やお好みの値を使うことができます。
  9. Tokenの値をコピーし、Done を選択します。

GitLab に Mattermost トークンを提供します。

Mattermost でスラッシュコマンドを作成すると、GitLab に提供しなければならないトークンが生成されます:

  1. GitLab ブラウザータブでアクティブチェックボックスを選択します。
  2. Tokenテキストボックスに、Mattermost からコピーしたトークンを貼り付けます
  3. 変更を保存を選択します。

これで、slash コマンドが GitLab プロジェクトと通信できるようになりました。

GitLab アカウントを Mattermost に接続しましょう。

前提条件

Mattermost スラッシュコマンドを使って GitLab とやり取りするには:

  1. Mattermost チャット環境で、新しいスラッシュコマンドを実行します。
  2. connect your GitLab accountto authorize access を選択します。

認証されたチャットアカウントは、Mattermost のプロフィールページのChat で確認できます。

トラブルシューティング

Mattermost のスラッシュコマンドが GitLab でイベントをトリガーしない場合:

  • 公開チャンネルを使用していることを確認してください。Mattermost Webhook は非公開チャンネルにアクセスできません。
  • 非公開チャンネルが必要な場合は、Webhook チャンネルを編集し、非公開チャンネルを選択してください。すべてのイベントは指定したチャンネルに送信されます。