简介
jira-git 是一个 Node.js 的 npm 包,它可以将 Git 提交信息同步到 JIRA 问题上。JIRA 是一个广泛使用的问题跟踪工具,而 Git 是一个广泛使用的版本控制工具。jira-git 的出现,使得在使用 Git 进行代码开发的同时,可以方便地将代码提交信息同步到 JIRA 问题上,提高协作的效率。
安装
使用 npm 安装 jira-git:
npm install jira-git --save-dev
使用方法
- 配置
在项目根目录下创建一个 .jira-gitrc
配置文件。该配置文件应该包括以下信息:
-- -------------------- ---- ------- - ------- - ----------- -------- ------- ------------------- ------- ---- ---------- -------------- ------- --------------- ----------- -------------- -- ------ - --------- - ------- --------- ------ ----------------------------------------- -- --------- -------- - -
其中,jira
中的配置项表示 JIRA 的相关信息,git
中的配置项表示 Git 的相关信息。需要根据自己的实际情况进行配置。
- 初始化
在项目根目录下运行 jira-git init
命令,初始化 jira-git。
- 提交代码
在提交代码时,使用如下的格式来书写 commit message:
[XXX-123] This is a commit message
其中,XXX-123
是 JIRA 中的问题号。
然后,使用如下的命令提交代码:
git add . git commit -m "[XXX-123] This is a commit message" git push
提交完成后,在 JIRA 的对应的问题页面上,可以看到和该次提交相关联的信息。
示例代码
-- -------------------- ---- ------- ----- ------- - -------------------- ----- ------- - - ----------- ------------- -- ---------------- -------- -- - --------------------- -------------- -- ------------ -- - --------------------- ---
总结
jira-git 使得在使用 Git 进行代码开发的同时,可以方便地将代码提交信息同步到 JIRA 问题上,提高协作的效率。使用 jira-git,需要先进行配置,然后在提交代码时使用指定的格式书写 commit message,就可以将信息同步到 JIRA 问题上了。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600557ff81e8991b448d51fe