使用 changeset 新增组件库更新日志

13 阅读2分钟

changeset 是一个用于版本管理和变更日志记录的工具,常用于现代前端项目中。它可以帮助团队更好地跟踪每个更改的影响,并自动生成变更日志。 如果你想在 changeset 中新增组件库的日志,你需要创建一个新的 changeset 文件。这个文件通常是一个 Markdown 格式的文件,其中包含了你想要添加到变更日志中的信息。 以下是具体步骤:

  1. 安装 Changeset CLI:如果你还没有安装 @changesets/cli,可以通过 npm 或 yarn 进行安装:

    npm install @changesets/cli --save-dev
    

    或者

    yarn add @changesets/cli --dev
    
  2. 初始化 Changeset(如果尚未初始化):

    npx changeset init
    
  3. 添加新的 Changeset: 运行以下命令来创建一个新的 changeset 文件:

    npx changeset
    
  4. 如果是 monorepo 项目,需要先选择更新的 package:

    i. 用 ↑ / ↓ 方向键移动光标,选择当前行的 package。

    ii. 按 Space(空格键) 勾选/取消勾选,勾选后前面会出现一个

     按一下空格:选中
     再按一下空格:取消选中
    

    iii. 完成选择后按 Enter(回车)继续下一步。

  5. 进入选择版本变更等级(patch / minor / major)。

  6. 填写 Changeset 内容: 在打开的编辑器中,你可以按照提示选择受影响的包以及此次变更的类型(major, minor, patch)。然后,在 Markdown 文档中详细描述这次变更的内容。 例如,假设你要为一个名为 my-component-library 的包添加一条日志,描述了一个新功能的添加,你可以这样写:

---
"my-component-library": patch
---

新增了一个按钮组件 (`Button`),支持多种主题颜色和尺寸选项。
  1. 提交 Changeset 文件: 保存并关闭编辑器后,Changeset 会在 .changeset 目录下生成一个新的文件,内容类似于上面的示例。
  2. 构建发布: 当你准备好发布这些更改时,运行以下命令来应用所有未发布的 changeset 并更新包的版本号:
    npx changeset version
    
    然后,你可以使用你喜欢的包管理工具来发布更新后的包,比如:
    npm publish
    
    或者
    yarn publish
    

通过以上步骤,你就可以成功地在 changeset 中新增组件库的日志了。每次运行 npx changeset version 后,所有的 changeset 文件会被合并成最终的 CHANGELOG.md 文件。 如果你需要更复杂的配置或有特定的需求,可以参考 Changeset 官方文档 获取更多信息。