NPM 包 @atomist/sdm-pack-issue 使用教程

阅读时长 6 分钟读完

在前端开发中,我们经常需要根据用户的反馈来调整优化我们的网站或应用。这时候就需要一种问题跟踪的方式来记录用户的反馈和对应的解决方案。@atomist/sdm-pack-issue 就是一个方便的 NPM 包,可以帮助我们快速地创建和管理问题。

在本篇文章中,我们将深入了解如何使用 @atomist/sdm-pack-issue 包,并通过简单易懂的示例代码来帮助读者快速掌握该包的使用和潜在优势。

什么是 @atomist/sdm-pack-issue?

@atomist/sdm-pack-issue 是一个适用于 Atomist SDM 的软件包,它提供了一个快速的问题跟踪功能。该包能够通过 Atomist 自动化服务帮助工程师创建和管理问题。其主要优势在于能够实现跨代码库、跨团队的问题管理。

如何安装和配置 @atomist/sdm-pack-issue?

在使用 @atomist/sdm-pack-issue 前,先确保你已经安装了 Node.js 和 Atomist SDM。如果还没有,请先安装官方的 Node.js 和 Atomist SDM。

接下来,我们需要在命令行中安装 @atomist/sdm-pack-issue

安装完成后,我们还需要在 Atomist SDM 的配置文件 atomist.config.ts 中进行如下配置:

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

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

以上配置中的 sendTo 属性是用来声明日志审查所需要的。如果你已经有了自己的日志审查规则,你也可以将该规则加入到 sendTo 属性中。

如何使用 @atomist/sdm-pack-issue?

现在我们已经完成配置,可以开始使用 @atomist/sdm-pack-issue 了。下面是一个使用 @atomist/sdm-pack-issue 创建问题的例子:

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

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

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

在以上代码中,我们通过 subscriptions 中的 AutoCodeInspection 添加了发布商场配置,并在 commands 属性中添加了一个 listener 来响应用户的创建问题请求。这个 listener 可以根据用户输入的目标存储库 (targets) 来创建问题,并返回结果信息。

在下面的示例代码中,我们将展示如何输入一条创建问题的命令和目标存储库:

通过以上创建命令,Atomist SDM 将会自动创建一个问题来跟踪 mbzhu/porsche 存储库中的问题。

以上就是使用 @atomist/sdm-pack-issue 的全部介绍。希望通过该包的介绍和示例代码,能够帮助读者更好地理解并使用该包进行问题追踪和管理。

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

纠错
反馈