npm 包 @webtrails/jira-issuer 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在开发过程中，往往需要将提交的代码与问题跟踪工具中的问题相关联，以便更好的追踪问题，查找解决方案。这篇文章主要介绍如何使用 npm 包 @webtrails/jira-issuer 将本地代码与 JIRA 问题关联起来。

步骤

安装

在项目根目录下安装该包：

npm install @webtrails/jira-issuer --save-dev

配置

该 npm 包需要在配置文件中进行配置。创建 .jiraissuerrc.json 文件，并添加以下配置信息：

{
  "jiraApiBaseUrl": "<JIRA API BASE URL>",
  "jiraApiToken": "<JIRA API TOKEN>",
  "jiraIssueKey": "<JIRA ISSUE KEY>",
  "jiraUsername": "<JIRA USERNAME>",
  "jiraProjectKey": "<JIRA PROJECT KEY>",
  "commitMsgFormat": "<COMMIT MESSAGE FORMAT>"
}

参数介绍：

jiraApiBaseUrl：JIRA API 的基本 URL
jiraApiToken：JIRA API token
jiraIssueKey：当前工作的 JIRA 问题 key，
jiraUsername：JIRA 用户名
jiraProjectKey：JIRA 项目 key，用于JQL查询
commitMsgFormat：提交消息格式，必须包含 %jira_issue_key%

使用

在提交代码时，需要包含 JIRA 问题 key，在 commit message 中加入 %jira_issue_key% 占位符，例如：

$ git commit -m "feat: Add new feature %jira_issue_key%"

该占位符将被替换为当前工作的 JIRA 问题 key。

可以使用以下命令将本地分支与 JIRA 问题相关联：

$ npx jira-issuer link -b <本地分支>

可以使用以下命令查看当前分支关联的 JIRA 问题：

$ npx jira-issuer info

总结

使用 npm 包 @webtrails/jira-issuer，可以轻松将本地代码与 JIRA 问题关联起来，更好的管理项目进度和跟踪问题。除了本文中介绍的基本使用方法外，还可以查阅官方文档获取更多用法和参数设置。

示例代码：https://github.com/WebTrails/jira-issuer-example

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055d2d81e8991b448dae87