变更集

此目录包含变更集，用于管理单体仓库中的版本控制和变更日志。

什么是变更集？

变更集是一种管理单体仓库中版本控制和变更日志的方式。它们允许您：

1. 记录对仓库中包的更改
2. 自动确定适当的版本号 bump（主版本、次版本、修补版本）
3. 根据更改生成变更日志
4. 发布包到 npm

如何使用变更集

添加变更集

当您对包进行更改时，应该添加一个变更集以描述这些更改：

运行`npm run changeset`

这将提示您：

1. 选择已更改的包（按空格键选择，回车确认）
2. 为每个包选择版本号 bump 的类型：
   • major：重大更改
   • minor：新功能（非破坏性）
   • patch：错误修复和小改动
3. 编写更改摘要

该摘要将包含在变更日志中，当包发布时显示。

版本管理包

准备好发布新版本的包时：

运行`npm run version-packages`

这将：

1. 消费所有变更集
2. 更新包版本
3. 更新变更日志
4. 创建包含这些更改的新提交

发布包

要将包发布到 npm：

运行`npm run release`

这将：

1. 构建所有包
2. 将包发布到 npm

CI/CD 集成

此仓库配置了一个 GitHub 工作流，该工作流：

1. 当将变更集添加到主分支时，创建一个带有版本更新的 PR
2. 合并 PR 时向 npm 发布包

该工作流在将更改推送到主分支时自动运行。

最佳实践

1. 按需创建变更集：每次进行显著更改时创建变更集，以使变更日志更详细和有用。

2. 编写有意义的变更集消息：描述更改的内容和原因，而不仅仅是文件发生了什么变化。

3. 使用适当的 bump 类型：

   • major：需要用户更新代码的重大破坏性更改
   • minor：不会破坏现有功能的新功能
   • patch：错误修复和小改动，不添加新功能或破坏现有代码

4. 在版本管理前检查变更集：确保所有更改已正确记录，再运行version-packages。

5. 保持包同步：对于紧密耦合的包，请考虑使用配置中的fixed选项以确保它们始终一起版本化。

故障排除

• 空变更集列表：如果npm run changeset显示没有包，请确保您的包有正确的package.json文件，并且包含name和version字段。

• 发布错误：如果发布失败，请检查是否具有正确的 npm 凭据，并且包名称可用。

• 合并变更日志中的冲突：通过保留所有条目并修复任何格式问题来解决冲突。

如需更多详细信息，请参阅官方变更集文档。