GitLab for Slack 应用管理
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
本页面包含 GitLab for Slack 应用的管理员文档。用户文档请参阅 GitLab for Slack 应用。
通过 Slack App Directory 分发的 GitLab for Slack 应用仅适用于 GitLab.com。 在 GitLab Self-Managed 上,您可以从 manifest file 创建您自己的 GitLab for Slack 应用副本,并配置您的实例。
该应用是一个私有的、一次性副本,仅安装在您的 Slack 工作区中,不会通过 Slack App Directory 分发。要在您的 GitLab Self-Managed 实例上使用 GitLab for Slack 应用,您必须启用该集成。
创建 GitLab for Slack 应用
前提条件:
- 您至少必须是 Slack 工作区管理员。
要创建 GitLab for Slack 应用:
-
在 GitLab 中:
- 在左侧边栏的底部,选择 管理员。
- 在左侧边栏中,选择 设置 > 通用。
- 展开 GitLab for Slack 应用。
- 选择 创建 Slack 应用。
然后您将被重定向到 Slack 以进行后续操作。
-
在 Slack 中:
- 选择要在其中创建应用的 Slack 工作区,然后选择 下一步。
- Slack 会显示应用摘要供您审阅。要查看完整的 manifest,请选择 编辑配置。要返回审阅摘要,请选择 下一步。
- 选择 创建。
- 选择 知道了 以关闭对话框。
- 选择 安装到工作区。
配置设置
创建 GitLab for Slack 应用 后,您可以在 GitLab 中配置设置:
- 在左侧边栏的底部,选择 管理员。
- 选择 设置 > 通用。
- 展开 GitLab for Slack 应用。
- 选中 启用 GitLab for Slack 应用 复选框。
- 输入您的 GitLab for Slack 应用的详细信息:
- 前往 Slack API。
- 搜索并选择 GitLab (<您的域名>)。
- 滚动到 应用凭证。
- 选择 保存更改。
测试您的配置
要测试您的 GitLab for Slack 应用配置:
- 在您 Slack 工作区的频道中输入
/gitlab help斜杠命令。 - 按 Enter 键。
您应该会看到可用的斜杠命令列表。
要为项目使用斜杠命令,请为该项目配置 GitLab for Slack 应用。
安装 GitLab for Slack 应用
前提条件:
- 您必须拥有向您的 Slack 工作区添加应用的相应权限。
- 您必须创建 GitLab for Slack 应用 并配置应用设置。
要从实例设置安装 GitLab for Slack 应用:
- 在左侧边栏的底部,选择 管理员。
- 选择 设置 > 集成。
- 选择 GitLab for Slack 应用。
- 选择 安装 GitLab for Slack 应用。
- 在 Slack 确认页面上,选择 允许。
更新 GitLab for Slack 应用
前提条件:
- 您至少必须是 Slack 工作区管理员。
当 GitLab 为 GitLab for Slack 应用发布新功能时,您可能需要手动更新您的副本以使用新功能。
要更新您的 GitLab for Slack 应用副本:
-
在 GitLab 中:
- 在左侧边栏的底部,选择 管理员。
- 在左侧边栏中,选择 设置 > 通用。
- 展开 GitLab for Slack 应用。
- 选择 下载最新的 manifest 文件 以下载
slack_manifest.json。
-
在 Slack 中:
- 前往 Slack API。
- 搜索并选择 GitLab (<您的域名>)。
- 在左侧边栏中,选择 应用 Manifest。
- 选择 JSON 选项卡以切换到 manifest 的 JSON 视图。
- 复制您从 GitLab 下载的
slack_manifest.json文件的内容。 - 将内容粘贴到 JSON 查看器中以替换任何现有内容。
- 选择 保存更改。
连接要求
要启用 GitLab for Slack 应用功能,您的网络必须允许 GitLab 和 Slack 之间的入站和出站连接。
- 对于 Slack 通知,GitLab 实例必须能够向
https://slack.com发送请求。 - 对于 斜杠命令 和其他功能,GitLab 实例必须能够接收来自
https://slack.com的请求。
启用对多个工作区的支持
默认情况下,您只能在一个 Slack 工作区中安装 GitLab for Slack 应用。 管理员在创建 GitLab for Slack 应用 时会选择此工作区。
要启用对多个 Slack 工作区的支持,您必须将 GitLab for Slack 应用 配置为未列出的分布式应用。 未列出的分布式应用:
- 不会在 Slack App Directory 中发布。
- 只能与您的 GitLab 实例一起使用,其他网站无法使用。
要将 GitLab for Slack 应用配置为未列出的分布式应用:
- 前往 Slack 上的 您的应用 页面,然后选择您的 GitLab for Slack 应用。
- 选择 管理分发。
- 在 与其他工作区共享您的应用 部分,展开 移除硬编码信息。
- 选中 我已审阅并移除了所有硬编码信息 复选框。
- 选择 激活公开分发。
故障排查
在管理 GitLab for Slack 应用时,您可能会遇到以下问题。
用户文档请参阅 GitLab for Slack 应用。
Slack 中的斜杠命令返回 dispatch_failed
斜杠命令在 Slack 中可能会返回 /gitlab failed with the error "dispatch_failed"。
要解决此问题,请确保:
- GitLab for Slack 应用已正确配置,并且已选中 启用 GitLab for Slack 应用 复选框。
- 您的 GitLab 实例允许与 Slack 之间的请求。