如何为我的 composer 包遵循语义化版本 (SemVer) 规范?

尼克
发布: 2025-11-09 16:48:03
原创
461人浏览过
遵循SemVer需正确使用MAJOR.MINOR.PATCH版本格式:不兼容API变更递增主版本号,新增向后兼容功能递增次版本号,修复bug递增修订号;通过Git标签(如v1.1.0)发布版本,Packagist自动同步;保持公共API兼容,破坏性变更须升级主版本并记录;维护CHANGELOG.md说明各版本变更内容,确保依赖者安全升级。

如何为我的 composer 包遵循语义化版本 (semver) 规范?

为你的 Composer 包遵循语义化版本(SemVer)规范,关键在于正确理解并应用版本号的格式 MAJOR.MINOR.PATCH,并根据代码变更的类型递增相应的部分。

理解 SemVer 版本结构

SemVer 使用三位数字表示版本:X.Y.Z,分别对应主版本号、次版本号和修订号。每次发布新版本时,依据变更类型决定哪一位需要增加:

  • MAJOR(X):当你做了不兼容的 API 修改时递增
  • MINOR(Y):当你以向后兼容的方式添加新功能时递增
  • PATCH(Z):当你进行向后兼容的问题修复时递增

例如,从 1.2.3 升级到:

  • 1.2.4 → 仅修复 bug
  • 1.3.0 → 添加了新功能,但没有破坏现有功能
  • 2.0.0 → 引入了不兼容的变更

composer.json 中设置版本

你不需要手动修改 composer.json 中的版本号。Composer 会根据 Git 标签来识别版本。你应该做的是:

  • 使用 Git 管理代码
  • 每次发布新版本时打一个标签,如 v1.0.0
  • 确保标签格式为 vX.Y.Z(v 是可选的,但推荐)

示例:

git tag v1.1.0
git push origin v1.1.0
登录后复制

Packagist 会自动抓取这个标签,并将其作为新版本发布。

拍我AI
拍我AI

AI视频生成平台PixVerse的国内版本

拍我AI 190
查看详情 拍我AI

保持 API 兼容性

为了真正遵循 SemVer,你需要对公共 API 的变更格外小心:

  • 不要删除或重命名公共类、方法或函数
  • 不要更改方法签名(参数数量、类型等)
  • 添加新方法或类属于 MINOR 变更
  • 修复行为错误属于 PATCH 变更

如果你必须打破兼容性,就升级主版本号(MAJOR),并清楚地记录变更内容。

撰写清晰的变更日志

维护一个 CHANGELOG.md 文件,列出每个版本的变更类型(新增、修复、破坏性变更),帮助用户判断是否可以安全升级。例如:

## v2.0.0 (2025-04-05)
### Breaking Changes
- 移除了废弃的 MyClass::oldMethod()
- 更改了 SomeService 构造函数参数
<h2>v1.1.0 (2025-03-20)</h2><h3>Added</h3><ul><li>新增了 Helper::formatOutput() 方法
登录后复制

基本上就这些。只要坚持按规则打标签、管理变更类型,并保持透明沟通,你的 Composer 包就能良好地遵循 SemVer。这会让依赖你包的开发者更安心地更新版本。

以上就是如何为我的 composer 包遵循语义化版本 (SemVer) 规范?的详细内容,更多请关注php中文网其它相关文章!

相关标签:
最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号