在 npm(Node.js 包管理器)中发布新版本时,遵循语义化版本控制规范(Semantic Versioning,简称 SemVer)是非常重要的。这有助于用户理解更新的性质以及可能影响他们项目的程度。根据 SemVer,版本号格式为 x.y.z,其中 x、y 和 z 分别代表主版本号、次版本号和补丁版本号。
以下是发布新版本时遵循的规则:
- 主版本(x)更新:当你进行了不兼容的 API 更改时,需要更新主版本号。例如,从 1.2.3 更新到 2.0.0。这意味着用户可能需要对其代码进行修改以适应新版本的包。
- 次版本(y)更新:当你添加了向后兼容的新功能时,需要更新次版本号。例如,从 1.2.3 更新到 1.3.0。用户可以安全地更新到此版本,而不必担心现有代码的兼容性问题。
- 补丁版本(z)更新:当你进行了向后兼容的错误修复时,需要更新补丁版本号。例如,从 1.2.3 更新到 1.2.4。这类更新通常包含对现有功能的修复和优化,用户可以放心地更新。
要发布新版本,请遵循以下步骤:
- 确保你的代码已经提交并推送到远程仓库。
- 在你的项目根目录中运行
npm version x.x.x
,其中 x.x.x 是你要发布的新版本号。这将更新你的package.json
文件中的版本号,并创建一个新的 Git 标签。 - 运行
git push --follow-tags
将更改推送到远程仓库,包括新的 Git 标签。 - 最后,运行
npm publish
将新版本发布到 npm 注册表。
确保在发布新版本之前充分测试你的代码,以便为用户提供稳定且可靠的软件包。