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

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

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

    bash 复制代码
    npm install @changesets/cli --save-dev

    或者

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

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

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

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

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

    复制代码
     按一下空格:选中
     再按一下空格:取消选中

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

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

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

markdown 复制代码
---
"my-component-library": patch
---

新增了一个按钮组件 (`Button`),支持多种主题颜色和尺寸选项。
  1. 提交 Changeset 文件: 保存并关闭编辑器后,Changeset 会在 .changeset 目录下生成一个新的文件,内容类似于上面的示例。

  2. 构建发布: 当你准备好发布这些更改时,运行以下命令来应用所有未发布的 changeset 并更新包的版本号:

    bash 复制代码
    npx changeset version

    然后,你可以使用你喜欢的包管理工具来发布更新后的包,比如:

    bash 复制代码
    npm publish

    或者

    bash 复制代码
    yarn publish

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

相关推荐
超哥--11 小时前
B站视频内容智能分析系统(九):React 前端与管理面板
前端·react.js·前端框架
Cutecat_14 小时前
视频字幕处理工具横向:提取模式 vs 编辑模式,该如何选择
android·前端·ios·语音识别
qq_4221525714 小时前
PDF 加水印工具怎么选?2026 年文档版权保护方案对比
前端·pdf·github
kyriewen14 小时前
手写 Promise.all、race、any:不到 30 行代码,解决并发异步的所有姿势
前端·javascript·面试
brucelee18615 小时前
OpenClaw 浏览器控制(Chrome MCP)完整教程
前端·chrome
ct97815 小时前
React 状态管理方案深度对比
开发语言·前端·react
胡志辉的博客16 小时前
深入浅出理解浏览器事件循环:从一道输出题讲到 Chrome 源码
前端·javascript·chrome·chromium·event loop
代码不加糖16 小时前
js中不会冒泡的事件有哪些?
前端·javascript·vue.js
懂懂tty16 小时前
Vue2与Vue3之间API差异
前端·javascript·vue.js
AI焦点16 小时前
跨越协议鸿沟:Tool Use状态机从Anthropic到OpenAI兼容体系的适配要点
前端·人工智能