Jenkins Jira 插件技术文档

1. 安装指南

系统要求

• Jenkins
• Jira Server 或 Jira Cloud

安装步骤

1. 登录 Jenkins dashboard。
2. 转到 “管理Jenkins” > “管理插件”。
3. 在插件管理页面中，选择 “可选插件” 选项卡。
4. 搜索 “Jira” 插件。
5. 选择插件并点击 “安装” 按钮。

2. 项目使用说明

Jenkins Jira 插件允许 Jenkins 与 Atlassian Jira 软件集成，无论是云版本还是服务器版本。以下是如何使用该插件的简要说明：

Jira Cloud 配置

1. 创建一个 API 令牌作为服务用户，以供 Jenkins 执行 API 调用。
2. 在 Jenkins 中创建全局凭据：
   • 用户名为 Atlassian ID 电子邮件。
   • 密码为 API 令牌。
3. 通过 curl 命令测试 API 令牌是否工作正常。

Jira REST API 使用

插件具有可选功能，可以更新 Jira 问题以添加指向 Jenkins 构建页面的反向指针。

Jira 问题链接

在 Jenkins 中配置 Jira 站点后，插件将自动将所有匹配的问题名称超链接到 Jira。

更新 Jira 问题

如果需要此功能，需要提供有效的用户 ID 和密码。如果需要评论仅对特定 Jira 组可见，请输入组名。

Jira 版本引用

可以通过添加 Jira 版本版本参数来引用 Jira 版本。

生成发布说明

可以从环境变量中检索用于构建的发布说明。

Jira 身份验证和权限

始终使用服务账户而不是个人账户来集成 Jenkins 和 Jira。确保 Jira 用户拥有足够的权限来执行其操作。

3. 项目 API 使用文档

以下是一些关键 API 的使用说明：

• GET /rest/api/latest/issue/{issueId}：检索 Jira 问题的详细信息。
• POST /rest/api/latest/issue：创建新的 Jira 问题。
• PUT /rest/api/latest/issue/{issueId}：更新 Jira 问题。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。以下是简要步骤：

1. 登录 Jenkins。
2. 转到插件管理。
3. 搜索并安装 Jira 插件。

确保遵循安装指南中的步骤，以确保插件正确安装并可以与 Jira 集成。