npm 包 semantic-sf-release 使用教程

简介

Semantic-sf-release 是一个基于 semantic-release 的构建工具,专为 Salesforce 创作的 npm 包提供封装。它使用 git 的标记来管理版本控制,将版本号格式化为 SemVer({major}.{minor}.{patch}),自动创建 GitHub Release,以及将变更日志写入 Release。Semantic-sf-release 也支持 SalesForce OpenCTI 软件包和 unmanaged package 管理。

安装

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

配置

package.json 中添加以下配置:

---------- -
  ---------- ----------------------------------
  ------------ -------------------------
  ---------- -
    ------------------------------------
    --------------------------------------------
    -
      ---------------------------------------------------
      -
        ---------- ------
        -------------- ----------------
        ----------------- ---
        -------------- --
      -
    --
    -
      ------------------------
      -
        --------- ---------------- --------------
      -
    --
    -
      ---------------------------
      -
        --------- ----------------
      -
    -
  -
-
  • extends: 指向一个公共的配置文件。在此配置文件中,将定义发布通知以及其他自定义配置。

  • tagFormat: Tag 格式,需要是版本号(SemVer)。标签将作为 Git 标签来创建。

  • plugins: 插件列表,将在发布前启用。这里定义了 @semantic-release/commit-analyzer@semantic-release/release-notes-generator@semantic-sf-release/salesforce-packaging-plugin@semantic-release/git 以及 @semantic-release/github。您可以使用这些插件为您的发布流程添加其他自定义功能。

使用

提交规范

首先,您需要使用提交规范。提交规范的格式需要符合 Conventional Commits 的定义。以下是一个例子:

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

这个编写格式包含三个部分:

  1. feat:用于标识提交类型,比如 featfixdocs 等。

  2. (Authentication):用于说明这个提交的影响范围。

  3. add support for OAuth2 authentication:用于说明这个提交的详细内容。

在这种提交规范下,每个提交都将根据其类型、影响范围以及详细内容自动生成版本控制信息。

发布

当您使用 semantic-sf-release 时,它会自动创建以下版本标记:

  • Commit message 中包含 fixfeatperf 的提交将产生新版本。

  • 手动运行 npm run release 将触发一个新版本的发布。

在任一情况下,semantic-sf-release 都将自动为新版本创建 GitHub 和 Salesforce 发布,并将您的变更日志填充到 GitHub Release 的正文中。它还会根据指定的上传文件列表自动为发布添加附件。有了这些自动化,您就不再需要手动编辑您的版本控制信息或手动创建发布。

示例代码

以下是一个例子:

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

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600558b781e8991b448d6067


猜你喜欢

  • npm 包 isopropyl-style-loader 使用教程

    在前端开发过程中,我们经常会使用 CSS 预编译器来提高效率和代码可维护性。而在使用预编译器的过程中,我们需要通过工具来将预编译器的 CSS 代码转换成浏览器可识别的 CSS 代码。

    2 年前
  • npm 包 json-to-form-data 使用教程

    前言 前端中常常需要进行数据的格式转换。其中,从 JSON 形式的数据转换为 FormData 数据格式是一种比较常见的需求。而当我们需要将 JSON 数据格式上传到后端时,我们往往需要将其转换为 F...

    2 年前
  • npm 包 swagger-ops 使用教程

    Swagger-ops 是一个非常方便的 npm 包,它可以帮助我们自动生成 API 文档、前端请求代码和测试文件。在前端开发中,使用 Swagger-ops 可以大大节省 API 文档和请求代码的撰...

    2 年前
  • npm 包 memoized-change-handler 使用教程

    前端开发过程中,经常需要使用监听输入框,下拉框等 DOM 元素的变化,并采取相应的操作,比如重新渲染某个组件等。而且在多个地方使用的时候,容易出现代码的冗余,维护起来也很费劲。

    2 年前
  • npm 包 @ull-alejandro-raul-35l2/ull-shape-square 使用教程

    什么是 @ull-alejandro-raul-35l2/ull-shape-square @ull-alejandro-raul-35l2/ull-shape-square 是一款 Node.js ...

    2 年前
  • npm 包 wrangler-object-mapper 使用教程

    介绍 wrangler-object-mapper 是一个用于 JavaScript 中的对象映射库,可通过简单的配置将 JSON 数据映射到 JavaScript 对象中,或将 JavaScript...

    2 年前
  • npm 包 nwsjs 使用教程

    什么是 nwsjs nwsjs 是一个基于 Node.js 和 Chromium 的轻量级 Web 服务器,提供了本地开发和测试的环境。它支持多个 Web 标准特性,如跨域请求、HTTP/HTTPS ...

    2 年前
  • npm 包 hydra-experimental 使用教程

    在前端开发中,我们经常使用各种 npm 包来实现我们的需求。hydra-experimental 是一个能够帮助我们更好地管理前端应用状态的 npm 包。在本文中,我们会详细讲解如何使用 hydra-...

    2 年前
  • npm 包 gulp-annotate 使用教程

    在前端开发过程中,经常会用到 gulp 自动化构建工具。gulp-annotate 是一个非常实用的 npm 包,它能够自动给 JavaScript 代码添加注解信息,以此提高代码可读性和可维护性。

    2 年前
  • npm 包 @berkanrhdz/ull-shape-berkanrhdz 使用教程

    简介 @berkanrhdz/ull-shape-berkanrhdz 是一款基于 JavaScript 的 npm 包。它提供了一些常见的形状计算,如圆形、矩形、正方形等。

    2 年前
  • npm 包 gloup.io 使用教程

    前言 在现代 Web 开发中,前端构建工具往往不仅仅是一个处理静态资源的工具,其功能逐渐扩展到了自动化测试、代码检查、代码打包、代码压缩、部署等方面。而 gloup.io 是一个基于 gulp 的轻量...

    2 年前
  • npm 包 passport-steam-some 使用教程

    前言 Steam 是一款热门的数字游戏平台,在前端项目中经常使用。而 passport-steam-some 是一款可以让你使用 Steam 账号进行登录认证的 npm 包,本文将详细介绍如何使用 p...

    2 年前
  • npm 包 udiui 使用教程

    在前端开发中,我们经常需要用到一些优秀的工具来提高开发效率和代码质量。其中,npm 包是一种非常常见和实用的工具,为我们提供了许多辅助开发的功能。在这篇文章中,我将介绍一个名为 udiui 的 npm...

    2 年前
  • npm 包 @alu0100769579/ull-shape-rectangle-alu0100769579 使用教程

    简介 @alu0100769579/ull-shape-rectangle-alu0100769579 是一个在 Node.js 和浏览器中使用的 npm 包,提供了创建矩形形状的功能。

    2 年前
  • npm 包 inject-main-test 使用教程

    在前端开发中,我们经常需要向 HTML 页面中插入一些 JavaScript 或 CSS 文件。常见的做法是手动添加 script 和 link 标签,但这种方式显然不够优雅和高效。

    2 年前
  • npm 包 basic-http-proxy 使用教程

    简介 basic-http-proxy 是一个基于 Node.js 的 HTTP 代理服务,可以将客户端的 HTTP 请求转发到指定的主机和端口。它支持安全的 HTTPS 连接,可以自定义请求头和响应...

    2 年前
  • npm 包 bingo-kiki-fullpage 使用教程

    在前端开发中,页面滚动效果是一个必不可少的功能,而全屏滚动效果更是非常受欢迎。而实现全屏滚动效果有很多种方式,其中有一种方式就是使用 npm 包 bingo-kiki-fullpage。

    2 年前
  • npm 包 text-net 使用教程

    text-net 是一个基于 Node.js 的 npm 包,它可以让你通过文本交互实现网络通信。这个包的功能不仅仅是简单地发送和接收消息,它可以让你使用文本协议与远程服务器进行交互。

    2 年前
  • npm 包 theta-control 使用教程

    前言 Theta-Control 是一款用于连接 Theta S 和 Theta V 等全景相机的 npm 包。它提供了一系列的 API 和命令,帮助我们在 web 应用中控制全景相机的各种操作。

    2 年前
  • npm 包 @alu0100769579/ull-shape-triangle-alu0100769579 使用教程

    @alu0100769579/ull-shape-triangle-alu0100769579 是一个前端类 npm 包,它可以用来计算三角形的周长和面积。本文将详细介绍如何使用该 npm 包,以及它...

    2 年前

相关推荐

    暂无文章