MaaFramework 项目版本号规范设计与实践

版本号设计背景

在软件开发过程中，版本号是标识软件发布状态的重要标识符。MaaFramework 项目作为一个开源框架，需要一套严谨的版本号规范来管理其发布过程。特别是在软件包管理场景下，传统的 commit hash 方式无法满足所有包管理器的要求，因此需要引入唯一数字标识来确保版本号的唯一性。

版本号结构设计

MaaFramework 采用了语义化版本号(SemVer)的扩展设计，整体结构如下：

<Version Core>[-<Version Unique ID>][+<Version Metadata>]

版本核心(Version Core)

版本核心遵循主版本号.次版本号.修订号的经典三段式结构，并增加了预发布和发布后标识：

主版本号.次版本号.修订号[-(alpha|beta|rc).预发布号][-post.发布后号]

• 主版本号、次版本号和修订号来自 Git 标签(v*)
• 预发布号标识开发阶段(alpha/beta/rc)
• 发布后号表示距离最近标签的提交次数

唯一标识(Version Unique ID)

为确保构建唯一性，增加了构建环境标识：

(ci.持续集成号|dev.本地构建号)

• CI 构建使用 GitHub Actions 的 run_id
• 本地构建推荐使用 Unix 时间戳

元数据(Version Metadata)

附加信息采用点分格式：

[${other_metadata}].[${commit_hash}.${date%Y%m%d}]

元数据仅允许使用字母数字字符，正式发布版本可省略哈希和日期信息。

版本号生成规则

CI 构建版本号

CI 环境生成的版本号格式为：

主版本号.次版本号.修订号[-(alpha|beta|rc).预发布号][-post.发布后号-ci.GitHub运行ID+提交哈希.日期]

标签命名规范

项目强制规定标签必须采用以下格式：

v主版本号.次版本号.修订号[-(alpha|beta|rc).预发布号]

正则表达式验证

为验证版本号格式，项目提供了严格的正则表达式：

^((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-(alpha|beta|rc)\.([1-9]\d*))?(?:-(?:post)\.([1-9]\d*))?)(?:-((?:ci|dev)\.([1-9]\d*)))?(?:\+(([0-9a-zA-Z][0-9a-zA-Z.]*?)??(?:\.?([0-9a-zA-Z]+)\.([0-9]{8}))?))?$

该正则支持多种编程语言，包括 JavaScript、Perl、PHP、Python 和 Go 等。

设计优势

1. 兼容性：既支持语义化版本规范，又能适应各种包管理器的要求
2. 可追溯性：通过唯一构建标识和元数据，可以精确定位代码状态
3. 自动化友好：严格的格式规范便于工具链自动化处理
4. 环境区分：清晰区分 CI 构建和本地构建结果

这套版本号规范为 MaaFramework 项目的版本管理提供了清晰的标准，确保了从开发到发布的整个生命周期中版本标识的一致性和可靠性。