在前端开发中,常常需要与 GitHub 和 JIRA 打交道。而当你在处理一个 Pull Request 时,会经常需要在 JIRA 上与相关人员沟通。这时,我们一个一个复制粘贴 URL 到 JIRA 上让人感到非常麻烦。为了简化这个过程,我们可以使用 npm 包 github-jira-pr。
github-jira-pr 是什么
github-jira-pr 是一个使用 GitHub API 和 JIRA API 的 CLI 工具,通过它,我们可以轻松创建包含 GitHub PR 信息的 JIRA Ticket,而无需手动复制贴上。
如何使用
首先,你需要安装全局包:
--- ------- -- --------------
接下来,你需要在你的 GitHub 账户和 JIRA 账户上创建一个 API Token,用于对 API 进行身份验证。
安装完成后,在命令行终端中运行以下命令:
-------------- -- ----------------- -- -------------- -- --------------- -- ------------
这将会列出你 GitHub Repository 中所有的 PR,你需要选择一个并通过Enter
键进入下一步。
- ------ - ---- ------- -- ---- - ------ ---- --- ----- ---- -- --------- ----- -- ------- -- -- --- --------- - -- -- --- ------ --- ------ -- ------ -- -- --- --- -------
接下来,工具会列出 GitHub Repositories 中打开选择 PR 时定义的 Issue,在每个 Issue 打开时查找 JIRA Issue。你需要选择一个 Issue 并通过Enter
键进入下一步。
- ------ -- ----- --- ---- ---- -------- ----- -- --- ------ --- ------ -- ------ - ----- -- --- --- -------
当你选择了 Issue 后,工具会为你提供一个类似于下面的命令:
-------------- -- ----------------- -- -------------- -- --------------- -- ------------ -- ----------- -- -------------- -- ------- -- ------------- -- --------- -- ---------
其中,-r
参数指定了 GitHub Repository,-i
参数指定了 Issue 号码,-t
参数指定了 JIRA Issue 的标题,-d
参数指定了 JIRA Issue 的描述,-l
参数指定了 JIRA Issue 的标签(多次使用 -l
参数以添加多个标签)。
完整示例:
-------------- -- ----------------- -- -------------- -- --------------- -- ------------ -- ----------- -- -------------- -- ---- --- -------- -- ------------ -- --- --- -------- -- --------- -- -------------
此时,工具会自动在 JIRA 上创建一个 Issue,其中包含 GitHub PR 信息。
学习意义
通过使用 github-jira-pr 这个工具,我们可以自动化创建包含 GitHub PR 信息的 JIRA Issue,大大提高了我们在这样的场景下的效率。同时,也让我们学到了如何使用 GitHub API 和 JIRA API 的知识。
结语
通过 github-jira-pr 工具,我们可以在自己的开发流程中自动化一些步骤,大大提高效率。同时,也可以通过学习这个工具,更好地理解 GitHub 和 JIRA 的 API 使用。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600671a130d0927023822389