禅道产品集成

如果您的团队使用禅道作为项目管理工具，那么可以使用极狐GitLab 的禅道集成功能，来获得更加无缝切换的产品使用体验。 启用禅道集成功能后，可以在极狐GitLab 实时同步查看禅道某个产品的所有需求、任务和 Bug 信息。

前提条件

  1. 极狐GitLab 版本在 14.5 及以上。

  2. 支持以下禅道版本：

    • 禅道 15.4
    • 禅道专业版 10.2
    • 禅道企业版 5.2
    • 禅道旗舰版 2.2
  3. 集成的禅道实例中，必须有一个可用的账号，和对应的 API token。

配置禅道

集成需要禅道 API secret key。

在禅道平台上完成以下步骤：

  1. 访问 管理员 页面并选择 二次开发 > 应用。
  2. 选择 添加应用。
  3. 在 名称 和 代号 下，输入新的 secret key 对应的应用名称和代号。
  4. 在 账号 下，选择一个已有账号的名称。
  5. 选择 保存。
  6. 复制生成的密钥，后续在极狐GitLab 中使用。

配置极狐GitLab

在极狐GitLab 上完成以下步骤，在指定的极狐GitLab 项目中，展示来自单个禅道产品的议题。

  1. 访问您指定的项目并选择 设置 > 集成。
  2. 选择 禅道。
  3. 在 启用集成 下，选择 启用。
  4. 提供以下禅道配置信息：
    • 禅道 Web URL：和极狐GitLab 集成的禅道系统实例的网页 URL，例如 example.zentao.net。
    • 禅道 API URL（可选）：禅道实例 API 的基础 URL，如不填则默认为与 Web URL 相同。

    • 禅道 API 令牌：使用您在配置禅道时生成的密钥。

      ZenTao API Token

    • 禅道产品 ID：配置要在极狐GitLab 指定项目上展示议题的禅道产品，可以在禅道产品页面下的 设置 > 概况 中找到对应的产品 ID。

      ZenTao settings page

  5. 要验证与禅道的连接是否正常，选择 测试设置。
  6. 选择 保存更改。

更新

根据禅道官方说明有如下版本调整，会影响到对其的上述集成：

  1. 开源版 18.11，企业版 8.11，旗舰版 4.11 版本及以前版本还支持通过禅道后台“二次开发 > 应用”中创建的密钥访问 API。
  2. 之后版本（开源版 18.12，企业版 8.12，旗舰版 4.12 及其以后版本）不支持通过禅道后台“二次开发 > 应用”中创建的密钥访问 API 了。
  3. 上述第二种情况下，可以通过禅道的账号和密码从https://{禅道访问域名}/api.php/v1/tokens 接口获取令牌，把它填入上面配置页面的“禅道 API 令牌”项即可正确连接。禅道的这个令牌有访问期限，过期后需要重新获取。