Semantic Versioning (SemVer) 教程

1. 项目介绍

** Semantic Versioning（SemVer）** 是一套规则和标准，用于指定软件版本号，以便开发者可以清晰地了解不同版本之间的兼容性和重要变更。它的核心原则是通过 主版本.次版本.修订版 的形式来表示软件版本，其中：

• 主版本号 (Major)：当引入不向后兼容的更改时增加。
• 次版本号 (Minor)：当添加功能但保持向后兼容性时增加。
• 修订版号 (Patch)：当进行修复但无任何功能变动或破坏兼容性时增加。

项目的官方网站 semver.org 提供了详细的规格说明和历史版本记录。

2. 项目快速启动

要开始使用 SemVer，在你的项目中创建一个名为 version 的文件，通常存储的是你的项目的主要版本信息。例如，创建一个名为 version.txt 的文件并设置初始版本：

echo "1.0.0" > version.txt

每次需要更新版本时，根据上述原则修改该文件中的数字。例如，添加一个次要版本：

sed -i 's/\(^[0-9]\+\).[0-9]\+\.[0-9]\+$/\1.1.0/' version.txt

这将把 1.0.0 更新为 1.1.0。

3. 应用案例和最佳实践

最佳实践

• 在发布新版本时，始终更新版本号以反映变化的性质。
• 使用预发布版本（如 1.2.0-alpha 或 1.2.0-rc.1）来标记不稳定或测试阶段的版本。
• 将构建标识符（如 1.2.3+githash）用于本地构建，这些不会影响公共API的向后兼容性。

案例分析

假设你在开发一个库，当你修复了一个非关键bug，你应该仅更新修订版（如从 1.0.1 到 1.0.2）。但如果新增了一个功能且保持向前兼容，则应提升次版本号（如从 1.0.0 到 1.1.0）。当引入重大重构或API改变时，主版本号应递增（如从 1.1.0 到 2.0.0）。

4. 典型生态项目

SemVer 被广泛应用于各种开源生态系统，包括：

• Node.js 的包管理系统 npm 遵循 SemVer 来管理依赖关系。
• Python 社区虽然没有强制执行，但许多项目也建议遵循 SemVer。
• Docker 中的镜像标签常常采用 SemVer 格式来表示不同版本。
• RubyGems 同样利用 SemVer 作为其包版本规范。

在实践中，大部分现代软件包管理和依赖解析工具都支持并鼓励使用 SemVer。

希望这个教程帮助你理解了 Semantic Versioning 并能将其有效应用到你的项目中。遵循 SemVer 可以提高软件维护的透明度，增强开发者间的合作和依赖管理。