Jira 议题集成
- 在极狐GitLab 17.6 中将名称改为 Jira 议题集成。
Jira 议题集成将一个或者多个极狐GitLab 项目连接到 Jira 实例。您可以在 Jira Cloud 托管您的 Jira 实例。支持的 Jira 版本为 6.x
、7.x
、8.x
和 9.x
。
- 在极狐GitLab 16.0 中引入使用 Jira 个人访问令牌认证。
- Jira 议题 和针对漏洞的 Jira 议题部分自极狐GitLab 16.10 引入,并使用名为
jira_multiple_project_keys
的功能标志。默认禁用。- Jira 议题 和针对漏洞的 Jira 议题部分在极狐GitLab 17.0 后 GA。功能标志
jira_multiple_project_keys
被移除。- 在极狐GitLab 17.0 中将 启用 Jira 议题重命名为查看 Jira 议题。
- 在极狐GitLab 17.0 中将 从安全漏洞启用 Jira 议题创建勾选框重命名为为安全漏洞创建 Jira 议题。
- 在极狐GitLab 17.5 引入自定义 Jira 议题设置。
先决条件:
- 确保您的极狐GitLab 安装实例不使用相对 URL。
-
针对 Jira Cloud:
- 您必须有一个 Jira Cloud API 令牌且您用来创建令牌的邮箱地址。
- 如果您已经开启了IP 允许列表 以及 JihuLab.com IP 范围以在极狐GitLab 汇总让允许列表查看 Jira 议题。
-
针对 Jira 数据中心或 Jira 服务器,您必须要有以下内容中的其中一个:
- Jira 用户名和密码。
- Jira 个人访问令牌(自极狐GitLab 16.0 以后)。
您可以在极狐GitLab 上通过配置项目设置来启用 Jira 议题集成。您还可以在私有化部署的实力上为特定的群组 或为整个 实例泪痣集成。
有了此集成,您的极狐GitLab 项目就可以和您实例上的所有 Jira 项目进行交互。如要在极狐GitLab 上配置您的项目设置:
- 在左侧边栏中,选择 搜索或转到 并找到您的项目。
- 在左侧边栏中,选择 设置 > 集成。
- 选择 Jira。
- 在 启用集成 下面,选择 激活 勾选框。
- 提供 Jira 配置信息:
-
Web URL:您要关联到此极狐GitLab 项目的 Jira 实例 Web 界面的基本 URL,例如
https://jira.example.com
。 -
Jira API URL:Jira 实例 API 的基本 URL,例如
https://jira-api.example.com
。 如果未设置,则默认为 Web URL 值。对 Jira Cloud,留空 Jira API URL。 -
认证方式:
-
Basic:
-
邮箱或用户名:
- 对 Jira Cloud,输入邮箱地址。
- 对 Jira Data Center 或 Jira 服务器,输入用户名。
-
API 令牌或密码:
- 对 Jira Cloud,输入 API 令牌。
- 对 Jira Data Center 或 Jira 服务器,输入密码。
-
邮箱或用户名:
- Jira 个人访问令牌 (对 Jira Data Center 和 Jira 服务器不可用):输入个人访问令牌。
-
Basic:
-
Web URL:您要关联到此极狐GitLab 项目的 Jira 实例 Web 界面的基本 URL,例如
- 提供触发设置:
- 选择 代码提交、合并请求 或者两者同时作为触发器。在您在极狐GitLab 上提及某个 Jira 议题 ID 时,极狐GitLab 就会链接至那个议题。
- 在 Jira 议题中添加注释,则会链接至极狐GitLab,然后选择 启用注释 勾选框。
- 为了在极狐GitLab 自动转换 Jira 议题,选择 启用 Jira 转换 勾选框。
- 在 Jira 议题匹配 部分:
- 对 Jira issue regex,输入 regex 模式。
- 对 Jira issue prefix,输入 prefix。
- 可选。为了在极狐GitLab 上查看 Jira 议题,在 Jira 议题 部分:
-
选择 查看 Jira 议题 勾选框。
WARNING: 当您开启此项设置,所有能够访问您极狐GitLab 项目的用户都可以从您指定的 Jira 项目查看所有议题。
-
输入一个或多个 Jira 项目 key。留空以包含所有可用的可用。
-
- 可选。为了在 针对安全漏洞的 Jira 议题 部分中为安全漏洞创建 Jira 议题:
-
选择 为安全漏洞创建 Jira 议题 勾选框。
NOTE: 您可以为单个的项目或群组开启此项设置。
- 输入 Jira 项目 key。
- 选择 为此项目 key 拉取议题类型 (),然后选择需要创建的 Jira 议题。
- 可选。当为安全漏洞创建议题时,选择 自定义 Jira 议题 勾选框以便能够审核、修改或为 Jira 议题添加详情。
-
- 可选。选择 测试设置。
- 选择 保存更改。
查看 Jira 议题
- 自极狐GitLab 16.9 引入为群组开启 Jira 议题功能。
- 在极狐GitLab 16.10 引入从多个 Jira 项目查看议题功能,并使用名为
jira_multiple_project_keys
的功能标志。默认禁用。- 该功能在极狐GitLab 17.0 中 GA。功能开关
jira_multiple_project_keys
被移除。
先决条件:
- 确保配置了 Jira 议题集成并切勾选了 查看 Jira 议题 勾选框。
您可以为特定的群组或项目启用 Jira 议题,但是您只能在极狐GitLab 项目上查看议题。如要在从极狐GitLab 项目上的一个或多个 Jira 项目上查看议题:
- 在左侧导航栏,选择 查找或转到并找到您的项目。
- 选择 极狐 > Jira 议题。
默认情况下,议题是根据 创建日期 排序的。最新创建的议题在最上面。您可以过滤议题并选择某个议题,在极狐GitLab 上进行查看。
议题基于各自的标签,被划分为以下三类:
- Open:议题只要不是 Done 状态,就会处于 Open 状态。
- Closed:议题处于 Done Jira 状态。 issues with a Done Jira status.
- All: 具有任何 Jira 状态的议题。
过滤 Jira 议题
- 通过项目过滤 Jira 议题自极狐GitLab 16.10 引入,并使用名为
jira_multiple_project_keys
的功能标志。默认禁用。- 在极狐GitLab 17.0 中该功能 GA。功能标志
jira_multiple_project_keys
被移除。
先决条件:
- 确保配置了 Jira 议题集成并勾选了 查看 Jira 议题 勾选框。
当您在极狐GitLab 上查看 Jira 议题时,您可以使用总结或描述中的文本来过滤议题。您还可以通过以下方法来过滤议题:
-
Label: 在 URL 的
labels[]
参数重指定一个或多个 Jira 议题标签。当您指定多个标签时,之后满足多个标签的议题才会被过滤出来。(比如,/-/integrations/jira/issues?labels[]=backend&labels[]=feature&labels[]=QA
)。 -
Status: 在 URL 的
status
参数中指定 Jira 议题状态。(比如,/-/integrations/jira/issues?status=In Progress
)。 -
Reporter: 在 URL 中指定
author_username
参数的 Jira 显示名称。(比如,/-/integrations/jira/issues?author_username=John Smith
)。 -
Assignee: 在 URL 中指定
assignee_username
参数的 Jira 显示名称。(比如,/-/integrations/jira/issues?assignee_username=John Smith
)。 -
Project: 在 URL 的
project
参数重指定 Jira 项目 key。(比如,/-/integrations/jira/issues?project=GTL
)。
为安全漏洞创建 Jira 议题
先决条件:
- 确认配置了 Jira 议题集成并勾选了 为安全漏洞创建 Jira 议题。
- 您必须要有一个能够在目标项目上创建议题权限的用户账号。
您可以从极狐GitLab 创建 Jira 议题以追踪能够解决或减缓安全漏洞风险的操作。为了为安全漏洞创建 Jira 议题:
- 在左侧导航栏,选择 查找或转到 并找到您的项目。
- 选择 安全 > 漏洞报告。
- 选择漏洞的描述。
-
选择 创建 Jira 议题。
如果选择了 自定义 Jira 议题设置,您将会被重定向到 Jira 实例上的 Jira 议题创建表单页面,此表单预填写了漏洞数据。在创建 Jira 议题前,您可以审核、修改或者添加详情。
此时就会在目标 Jira 项目上创建好议题,该议题包含安全漏洞报告的信息。
为了创建极狐GitLab 议题,可查看为安全漏洞创建极狐GitLab 议题。
创建 Jira Cloud API 令牌
为了为 Jira Cloud 配置 Jira 议题集成,您必须要有一个 Jira Cloud API 令牌。为了创建 Jira Cloud API 令牌:
-
使用对 Jira 项目具有写权限的账号登录 Atlassian。
打开 API 令牌 页面。从您的 Atlassian 个人资料中,选择 账号设置 > 安全 > 创建和管理 API 令牌。
- 选择 创建 API 令牌。
- 在对话框上,为您的令牌输入标签并选择 创建。
要想拷贝 API 令牌,选择 拷贝。
从 Jira Server 迁移到 Jira Cloud
- 在极狐GitLab 17.6 中集成名称更新为 Jira 议题。
为了在极狐GitLab 中从 Jira Server 迁移到 Jira Cloud,并维护您的 Jira 议题集成:
- 在左侧导航栏,选择 查找或转到 来找到您的项目。
- 选择 设置 > 集成。
- 选择 Jira 议题。
- 在 Web URL,输入新的 Jira 站点 URL(比如,
https://myjirasite.atlassian.net
)。 - 在 邮箱或用户名,输入您 Jira 个人资料中注册的邮箱。
- 创建 Jira Cloud API 令牌并拷贝令牌值。
- 在 API 令牌或密码 部分,粘贴 API 令牌值。
- 可选。选择 测试设置。
- 选择 保存更改。
为了在极狐GitLab 中更新既有的 Jira 议题参考以使用新的 Jira 站点 URL,您必须使 Markdown 缓存失效。