npm 包 @endemolshinegroup/cz-jira-smart-commit 使用教程

阅读时长 3 分钟读完

前言

在团队协作开发中,我们经常需要对 JIRA 上的 task 进行操作,如更新状态、添加备注、关联代码等。为了方便我们管理任务,我们通常会在提交代码时将 commit message 写成一定格式的 JIRA 任务号 + 简要说明;而随着项目规模的增大,这种方式也逐渐变得复杂和不易维护。因此,我们可以采用 npm 包 @endemolshinegroup/cz-jira-smart-commit 来自动生成符合要求的 commit message。

@endemolshinegroup/cz-jira-smart-commit 简介

@endemolshinegroup/cz-jira-smart-commit 是一个开源的 npm 包,其主要功能是在 git commit 的过程中,将开发者的输入转换为标准的 JIRA 智能提交地址,并将提交信息自动更新到 JIRA 任务中。使用该包可以使我们更加方便地管理任务,提高开发效率。

@endemolshinegroup/cz-jira-smart-commit 的安装

要使用 @endemolshinegroup/cz-jira-smart-commit,我们需要利用 npm 进行安装:

@endemolshinegroup/cz-jira-smart-commit 的使用

安装成功后,我们需要将该包作为 commitizen 的 adapter,并配置相应的信息。下面是一个基本的使用示例。

1. 配置 package.json 文件

在项目根目录下的 package.json 文件中添加如下配置:

-- -------------------- ---- -------
-
  ---------- -
    --------- ----
  --
  --------- -
    ------------- -
      ------- -----------------------------------
    --
    ----------------------- -
      ------- ----------------------------
      --------- ------
      ----------- -------------
      ---------------- ----- --------
      --------------- ----- -------
      -------------------- ----- -----------
    -
  -
-

其中,"host" 需要替换成你团队的 JIRA 地址;"prefix" 需要替换成你团队的 JIRA 的任务前缀;"matching" 表示你的 JIRA 任务编号的格式,此处为 ABC-XXX 格式;"jiraStatusCmd"、"jiraIssueCmd"、"jiraTransitionCmd" 是用于与 JIRA 进行交互的命令行指令。

2. 提交代码

在提交代码时,我们只需要按照提示输入相应的信息即可。例如,如果当前的任务编号为 ABC-123,我们需要将代码提交到 "feat: add foo bar" 对应的任务,那么只需要按照如下格式进行提交:

然后按照提示输入相关信息即可完成提交。

总结

使用 npm 包 @endemolshinegroup/cz-jira-smart-commit,可以让我们更加方便地管理 JIRA 任务。该包的安装和配置比较容易上手,但是需要注意的是,不同团队所需的配置项可能会有所不同。因此,在使用之前,需要仔细阅读包的文档,并根据团队需要进行相应的配置。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600668e1d9381d61a3540939

纠错
反馈