Mattermost 斜杠命令
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
您可以使用 斜杠命令 在 Mattermost 聊天环境中执行常见的 GitLab 操作, 例如创建 issue。
GitLab 还可以将事件(如 issue created)发送到 Mattermost,这是作为单独配置的 Mattermost 通知 的一部分。
有关可用斜杠命令的列表,请参阅 斜杠命令。
配置选项
GitLab 提供了多种配置 Mattermost 斜杠命令的方式。对于任何这些选项, 您必须拥有 Mattermost 3.4 或更高版本。
- Linux 包安装:Mattermost 与 Linux 包 捆绑在一起。要为 Linux 包安装配置 Mattermost, 请阅读 Linux 包 Mattermost 文档。
- 如果 Mattermost 与 GitLab 安装在同一台服务器上,请使用 自动配置。
- 对于所有其他安装,请使用 手动配置。
自动配置
如果 Mattermost 与 GitLab 安装在同一台服务器上, 您可以自动配置 Mattermost 斜杠命令:
- 在左侧边栏,选择 Search or go to 并找到您的项目。
- 选择 Settings > Integrations。
- 选择 Mattermost slash commands。
- 在 Enable integration 下,确保选中 Active 复选框。
- 选择 Add to Mattermost,然后选择 Save changes。
手动配置
要在 Mattermost 中手动配置斜杠命令,您必须:
- 在 Mattermost 中启用自定义斜杠命令。 此步骤仅适用于自编译安装。
- 从 GitLab 获取配置值。
- 在 Mattermost 中创建斜杠命令。
- 向 GitLab 提供 Mattermost 令牌。
在 Mattermost 中启用自定义斜杠命令
要从 Mattermost 管理员控制台启用自定义斜杠命令:
- 以具有管理员权限的用户身份登录 Mattermost。
- 在您的用户名旁边,选择 Settings 图标,然后 选择 System Console。
- 选择 Integration Management,并将这些值设置为
TRUE:- Enable Custom Slash Commands
- Enable integrations to override usernames
- Enable integrations to override profile picture icons
- 选择 Save,但不要关闭此浏览器标签页。您在 后续步骤中需要它。
从 GitLab 获取配置值
要从 GitLab 获取配置值:
- 在另一个浏览器标签页中,以具有管理员访问权限的用户身份登录 GitLab。
- 在左侧边栏底部,选择 Admin(管理员)。
- 选择 Settings > Integrations。
- 选择 Mattermost slash commands。GitLab 会显示 Mattermost 设置的建议值。
- 复制 Request URL 值。所有其他值都是建议值。
- 不要关闭此浏览器标签页。您在 后续步骤中需要它。
在 Mattermost 中创建斜杠命令
要在 Mattermost 中创建斜杠命令:
-
在 Mattermost 浏览器标签页中, 转到您的团队页面。
-
选择 Settings 图标,然后选择 Integrations。
-
在左侧边栏,选择 Slash commands。
-
选择 Add Slash Command。
-
为您的新命令提供 Display Name 和 Description。
-
根据您的应用程序配置提供 Command Trigger Word:
- 如果您只想将一个项目连接到您的 Mattermost 团队,请使用
/gitlab作为触发词。 - 如果您想连接多个项目,请使用与您的项目相关的触发词,
例如
/project-name或/gitlab-project-name。
- 如果您只想将一个项目连接到您的 Mattermost 团队,请使用
-
对于 Request URL,粘贴您从 GitLab 复制的值。
-
对于所有其他值,您可以使用 GitLab 的建议值或您 首选的值。
-
复制 Token 值,然后选择 Done。
向 GitLab 提供 Mattermost 令牌
在 Mattermost 中创建斜杠命令会生成一个您必须 提供给 GitLab 的令牌:
- 在 GitLab 浏览器标签页中, 选择 Active 复选框。
- 在 Token 文本框中,粘贴您从 Mattermost 复制的令牌。
- 选择 Save changes。
您的斜杠命令现在可以与您的 GitLab 项目通信。
将您的 GitLab 账户连接到 Mattermost
先决条件:
要使用 Mattermost 斜杠命令与 GitLab 交互:
- 在 Mattermost 聊天环境中,运行您的新斜杠命令。
- 选择 connect your GitLab account(连接您的 GitLab 账户)以授权访问。
您可以在 Mattermost 个人资料页面的 Chat 下查看所有已授权的聊天账户。
相关主题
故障排除
当 Mattermost 斜杠命令未在 GitLab 中触发事件时:
- 确保您使用的是公开频道。 Mattermost webhook 无法访问私有频道。
- 如果您需要私有频道,请编辑 webhook 频道, 并选择一个私有频道。所有事件都会发送到指定的频道。