• Smart Commits
  • Smart Commit 语法
• 为 DVCS 配置极狐GitLab 应用程序
• 为 DVCS 配置 Jira
• 刷新导入到 Jira 的数据
• 迁移到 GitLab for Jira Cloud 应用程序
  • Jira Cloud app DVCS 与 GitLab 功能对比
  • 迁移的风险

Jira DVCS 连接器

如果您自托管 Jira 实例，并且希望在极狐GitLab 和 Jira 之间同步信息，请使用 Jira DVCS（分布式版本控制系统）连接器。如果您使用 Jira Cloud，您应该使用 GitLab for Jira Cloud app，除非您特别需要 DVCS 连接器。

配置 Jira DVCS 连接器时，请确保您的极狐GitLab 和 Jira 实例可访问。

• 私有化部署版极狐GitLab：Jira 必须可以访问您的极狐GitLab 实例。
• Jira Server：您的网络必须允许访问您的实例。
• Jira Cloud：您的实例必须可以通过互联网访问。

Smart Commits

使用 DVCS 将极狐GitLab 与 Jira 连接时，您可以在您的提交消息中，使用称为 Smart Commits。使用智能提交，您可以：

• 评论议题。
• 记录针对议题的时间跟踪信息。
• 将议题转换为 Jira 项目工作流中定义的任何状态。

命令必须位于提交消息的第一行。Jira Software 文档 包含有关 Smart Commits 如何工作以及可用命令的更多信息。

要使 Smart Commits 可以使用，极狐GitLab 上的提交用户必须在 Jira 上有一个具有相同电子邮件地址或用户名的相应用户。

Smart Commit 语法

Smart Commits 应遵循以下模式：

<ISSUE_KEY> <ignored text> #<command> <optional command parameters>

示例如下：

• 向 Jira 议题添加评论：KEY-123 fixes a bug #comment Bug is fixed.
• 记录时间跟踪：KEY-123 #time 2w 4d 10h 52m Tracking work time.
• 关闭议题：KEY-123 #close Closing issue

Smart Commit 消息不能超过一行（无回车），但您仍然可以在一次提交中执行多个操作。例如：

• 添加时间跟踪，添加评论，并转换状态到 已关闭：

  KEY-123 #time 2d 5h #comment Task completed ahead of schedule #close
  

• 添加评论，转换状态到 进行中，并添加时间跟踪：

  KEY-123 #comment started working on the issue #in-progress #time 12d 5h
  

为 DVCS 配置极狐GitLab 应用程序

对于单个群组中的项目，我们建议您创建一个群组应用程序。 对于跨多个群组的项目，我们建议您在极狐GitLab 中创建和使用 jira 用户，并且该账户仅用于集成工作。单独的账户可确保定期账户维护不会影响您的集成。如果 jira 用户或组应用程序不可行，您可以将此集成设置为实例范围的应用程序，或使用用户拥有的应用程序代替。

1. 导航到 应用程序 部分。
2. 在 名称 字段中，为集成输入一个描述性名称，例如 Jira。
3. 在 重定向 URI 字段中，输入适合您的极狐GitLab 版本的 URI，将 <gitlab.example.com> 替换为您的极狐GitLab 实例域名：
   • 对于极狐GitLab 13.0 及更高版本、Jira 8.14 及更高版本，使用与 Jira 关联极狐GitLab 账户中生成的 Redirect URL。
   • 对于极狐GitLab 13.0 及更高版本、Jira Cloud，使用 https://<gitlab.example.com>/login/oauth/callback。
   • 对于极狐GitLab 11.3 及更高版本、Jira 8.13 及更早版本，使用 https://<gitlab.example.com>/login/oauth/callback。 如果您使用 SaaS，URL 为 https://gitlab.com/login/oauth/callback。
   • 对于极狐GitLab 11.2 及更早版本，使用 https://<gitlab.example.com>/-/jira/login/oauth/callback。
4. 对于 Scopes，选择 api 并清除任何其他复选框。
   • DVCS 连接器需要一个可写的 api 范围来自动创建和管理所需的 webhook。
5. 选择 提交。
6. 复制 应用程序 ID 和 Secret 值。您需要它们来配置 Jira。

为 DVCS 配置 Jira

当您想要将您指定的群组的所有极狐GitLab 提交和分支导入 Jira 时，配置此连接。此导入需要几分钟时间，完成后每 60 分钟刷新一次：

1. 完成极狐GitLab 配置。
2. 访问您的 DVCS 账户：
   • Jira Server，选择 设置 (gear) > 应用程序 > DVCS 账户。
   • Jira Cloud，选择 设置 (gear) > 产品 > DVCS 账户。
3. 要创建新集成，请为 Host 选择适当的值：
   • 对于 Jira 8.14 及更高版本：选择 GitLab 或 GitLab Self-Managed。
   • 对于 Jira Cloud 或 Jira 8.13 及更早版本：选择 GitHub Enterprise。
4. 对于 团队和用户账户，输入：
   • 对于 Jira 8.14 及更高版本：
     • 极狐GitLab 用户有权访问的顶级极狐GitLab 群组的相对路径。
   • 对于 Jira Cloud 或 Jira 8.13 及更早版本：
     • 极狐GitLab 用户有权访问的顶级极狐GitLab 群组的相对路径。
     • 您的个人命名空间的相对路径。
5. 在 Host URL 字段中，输入适合您的极狐GitLab 版本的 URI，将 <gitlab.example.com> 替换为您的极狐GitLab 实例域名：
   • 对于 11.3 及更高版本，使用 https://<gitlab.example.com>。
   • 对于 11.2 及更早版本，使用 https://<gitlab.example.com>/-/jira。
6. 对于 客户端 ID，使用上一节中的 应用程序 ID 值。
7. 对于 客户端 Secret，使用上一节中的 Secret 值。
8. 确保选中其余的复选框。
9. 要创建 DVCS 账户，请选择 添加，然后选择 继续。
10. Jira 重定向到极狐GitLab，您必须在其中确认授权。极狐GitLab 然后重定向回 Jira，同步的项目应该显示在新账户中。

要连接来自其他极狐GitLab 顶级群组或个人命名空间的其他极狐GitLab 项目，请使用其他 Jira DVCS 账户重复前面的步骤。

配置集成后，请阅读有关如何测试和使用它的更多信息。

刷新导入到 Jira 的数据

Jira 每 60 分钟为您的项目导入一次提交和分支。您可以从 Jira 界面手动刷新数据：

1. 以您配置集成的用户身份登录您的 Jira 实例。
2. 转到 设置（gear）> 应用程序。
3. 选择 DVCS 账户。
4. 在表中，对于要刷新的代码仓库，在 上次活动 列中，选择图标。

迁移到 GitLab for Jira Cloud 应用程序

如果您将 DVCS 与 Jira Cloud 一起使用，则应考虑迁移到 GitLab for Jira 应用程序。 Jira Cloud 的 DVCS 将废弃于 16.0 版本。

要开始使用 GitLab for Jira Cloud 应用程序，请遵循指南安装 GitLab for Jira Cloud 应用程序。

Jira Cloud app DVCS 与 GitLab 功能对比

迁移的风险

GitLab for Jira Cloud 应用程序同步历史数据的能力有限。 只有在安装 GitLab for Jira Cloud 应用程序后创建的分支、提交、构建、部署和功能标志才会与 Jira 同步。