Skip to content

版本策略

YH-UI 遵循语义化版本策略,目标是让使用者能预测升级风险,并让维护者清楚每次发布的责任边界。

版本号

版本号格式为 MAJOR.MINOR.PATCH

类型示例含义
Major2.0.0包含不兼容变更,需要迁移
Minor1.1.0新功能、组件增强、向后兼容能力
Patch1.0.8Bug 修复、文档修正、内部优化

变更分类

Patch

  • 修复组件 bug。
  • 修复类型声明。
  • 修复文档错误。
  • 不改变公开 API 的内部优化。
  • 补充测试和验证脚本。

Minor

  • 新增组件、props、事件、插槽、组合式 API。
  • 新增公开 Token。
  • 增强文档 playground 或 sandbox。
  • 新增 Nuxt、SSR、自动导入等兼容能力。

Major

  • 删除或重命名公开 API。
  • 修改默认行为并可能影响现有业务。
  • 删除或重命名公开 Token。
  • 改变包导出结构或最低运行环境。

发布门禁

正式发布前至少需要:

  • 类型检查通过。
  • lint 和格式检查通过。
  • 单元测试和 SSR 测试通过。
  • 组件质量或覆盖率门禁通过。
  • 构建通过。
  • Consumer smoke 通过。
  • docs build、docs playground、sandbox 验证通过。
  • 更新 changelog 和迁移说明。

废弃流程

不推荐立即删除 API。推荐流程:

  1. 在文档和控制台 warning 中标记 deprecated。
  2. 给出替代 API 和迁移示例。
  3. 至少保留一个 minor 周期。
  4. 在下一个 major 中删除。

预发布版本

预发布版本用于验证大改动:

  • alpha:功能仍可能变化。
  • beta:API 基本稳定,等待真实项目反馈。
  • rc:候选发布版本,只接受阻塞级修复。

Changelog 要求

每次发布应包含:

  • 新增能力。
  • 修复问题。
  • 不兼容变更。
  • 迁移说明。
  • 验证范围。
  • 已知风险。

Released under the MIT License.