0

0

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

尼克

尼克

发布时间:2025-11-09 16:48:03

|

493人浏览过

|

来源于php中文网

原创

遵循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 会自动抓取这个标签,并将其作为新版本发布。

HIX.AI
HIX.AI

HIX.AI是一个多功能的一体化AI写作助手,集成了120多种AI写作工具,支持50多种语言,能够满足各种写作需求。

下载

保持 API 兼容性

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

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

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

撰写清晰的变更日志

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

## v2.0.0 (2025-04-05)
### Breaking Changes
- 移除了废弃的 MyClass::oldMethod()
- 更改了 SomeService 构造函数参数

v1.1.0 (2025-03-20)

Added

  • 新增了 Helper::formatOutput() 方法

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

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

147

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

402

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

306

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

637

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

523

2023.07.06

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

262

2023.07.24

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

0

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

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