组件更新与版本管理
对已发布的组件进行版本迭代,修复问题或添加新功能。
更新流程
1. 下载组件
进入「我的组件」,找到需要更新的组件,点击「更新」按钮。在更新页面:
- 点击「下载」获取当前版本
- 选择保存路径(项目的 components 目录)
- 确认下载完成
2. 本地修改
在项目中打开下载的组件文件夹,进行修改:
- 修复 bug
- 添加新功能
- 优化性能
- 更新文档
3. 测试验证
在本地环境中测试修改后的组件,确保:
- 原有功能正常
- 新增功能按预期工作
- 无控制台错误
4. 上传更新
回到 comp-hub 的更新页面:
- 选择修改后的组件文件夹
- 更新版本号(如文件内容有变更)
- 调整预览配置(如有需要)
- 修改组件描述(建议说明变更内容)
- 点击「更新」发布
版本号规范
组件版本遵循语义化版本规范:
主版本.次版本.补丁版本| 版本类型 | 变更内容 | 示例 |
|---|---|---|
| 补丁版本 | Bug 修复,向后兼容 | 1.0.0 → 1.0.1 |
| 次版本 | 新功能,向后兼容 | 1.0.0 → 1.1.0 |
| 主版本 | 破坏性变更 | 1.0.0 → 2.0.0 |
何时更新版本号
必须更新:
- 修改了组件代码(.vue 文件)
- 变更了组件的 props 接口
- 调整了组件行为逻辑
无需更新:
- 仅修改预览配置
- 仅更新组件描述
版本号修改方式
方式一:在更新页面修改(推荐)
在组件更新页面的配置区域,直接修改版本号输入框,系统会自动更新 comp.json 文件。
方式二:本地手动修改
在本地项目中手动修改 comp.json 中的版本号:
json
{
"name": "MyComponent",
"version": "1.1.0"
}版本管理
多版本并存
平台保留组件的所有历史版本,用户可以:
- 在预览页切换查看不同版本
- 下载任意历史版本使用
- 比较版本间的差异
最佳实践
变更日志
在组件的 README.md 中维护变更日志:
markdown
## 更新日志
### 1.1.0 (2024-01-15)
- 新增:支持自定义主题色
- 优化:提升大数据量下的渲染性能
### 1.0.1 (2024-01-10)
- 修复:修复在某些情况下 tooltip 不显示的问题
### 1.0.0 (2024-01-01)
- 初始版本发布向后兼容
- 尽量保持 props 接口稳定
- 如需废弃某个属性,先在文档中标记为 deprecated
- 破坏性变更务必升级主版本号