npm 包 changeset 使用教程

概述

npm 包 changeset 是一个用于生成版本更新日志的工具,能够记录变动信息并生成易于阅读的模板。使用 changeset 有助于团队成员更加清晰地了解项目中的变动,并且更加便捷地查看历史变动记录。

本文将介绍如何使用 changeset 来记录版本更新日志,从安装开始,到配置和使用,再到最佳实践,详细地介绍每个步骤。

安装

运行以下命令来安装 changeset:

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

配置

初始化

在项目根目录下运行以下命令,以初始化 changeset:

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

这将创建一个 changeset.config.js 配置文件,存储 changeset 的一些选项。

配置选项

随后,我们需要配置一些选项。

packages

packages 表示需要被记录变动信息的包。

changeset.config.js 中添加以下代码:

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

这样,只有 package-1package-2 的变动信息才会被记录。

release

release 表示当前的版本。初始版本 release 为 0.0.0

changeset.config.js 中添加以下代码:

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

这样,在记录日志时,会从 release 的版本开始。比如,如果 release 为 2.0.0,则只会记录 2.0.0 之后的变动信息。

changelog

changelog 表示生成日志的格式。

changeset.config.js 中添加以下代码:

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

这里使用了默认配置,生成的格式如下:

-- --------

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

---- -----

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

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

---- -----

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

其中 commitLimit 表示每个包展示的提交数量,tagPrefix 表示标签的前缀,group 表示分组的名称,version 表示版本号的格式,date 表示日期的格式,changes 表示变动类型。我们也可以根据实际需求进行更改。具体的配置项和示例可以参考 changeset 官方文档

常用命令

安装和配置完成后,我们可以运行以下命令来使用 changeset。

changeset status

执行 changeset status 可以查看未被记录的提交。

changeset add

执行 changeset add 可以将未被记录的提交添加到变动信息中。

changeset version

执行 changeset version 可以为 packages 设定新版本,生成更新日志。

changeset release

执行 changeset release 可以将更新日志发布为 stable 版本。

最佳实践

结合 CI/CD

为了保证每次部署时都能及时更新版本和更新日志,我们可以将 changeset 集成到 CI/CD 流程中。

以 Jenkins 为例,我们可以在 Jenkinsfile 中添加以下代码:

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

这样,每次构建时,changeset 就会自动更新版本和更新日志,并发布为 stable 版本。

基于模板生成更新日志

我们可以使用模板来生成更新日志,改为满足特定需求的格式。

请按照以下步骤操作。

创建模板文件

在项目根目录下,创建一个名为 template.ejs 的文件,内容可以是以下示例代码:

-----

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

更改配置

changeset.config.js 中更改 changelog 配置:

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

这里使用 preset: 'angular' 来告诉 changeset 使用 Angular 风格的配置生成更新日志,最后指定输出为 template.ejs

运行 changeset

运行 changeset release 来生成更新日志。

集成 GitHub Action

除了结合 CI/CD 使用 changeset,我们还可以将 changeset 集成到 GitHub Action 中,在每次 pull request 和 merge 后自动生成更新日志并发布为 release 版本。

请按照以下步骤操作。

创建 GitHub Action

在你的 GitHub 仓库中,转到 Actions 选项卡,点击 New workflow 按钮,选择 Set up a workflow yourself 选项,即可创建一个新的 GitHub Action。

.github/workflows/changeset.yml 文件中添加以下代码:

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

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

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

这里运行了一个名为 changeset 的任务,其中务必添加 NODE_AUTH_TOKEN 环境变量,否则发布 release 版本时将因为权限问题出现错误。

配置 Secrets

在 GitHub 仓库设置中,转到 Secrets 选项卡,添加一个名为 NODE_AUTH_TOKEN 的 key,将你的 npm token 存储在其中。

完成

完成上面的步骤后,你就可以愉快地使用 changeset 了。

结语

通过本文,我们可以学习使用 changeset 记录版本更新日志,从安装开始到使用,再到最佳实践,了解了如何使用 changeset 提高项目管理效率。希望本文对读者有所帮助。

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


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    1 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    1 个月前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    1 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    1 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    1 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    1 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    1 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    1 个月前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    1 个月前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    1 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    1 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    1 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    1 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    1 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    1 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    1 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    1 个月前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    1 个月前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    1 个月前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    1 个月前

相关推荐

    暂无文章