Skip to content

发版流程与版本规范 ​

每次发版必须完成两件事(已写入 server_api/docs/CODE_STYLE.md 通用协作规范):

  1. 更新版本号:修改 config.example.yaml 顶层的 version 配置——版本号唯一来源是 config.yaml,服务启动时校验必填,生产环境同步 config.yaml;
  2. 新增版本说明:在 server_api/docs/update_doc/ 下新增 v{version}.md。

版本号语义 ​

变化类型版本动作示例
不兼容的接口、配置或数据结构调整主版本 +1,其余归零1.4.2 → 2.0.0
向后兼容的新功能次版本 +11.4.2 → 1.5.0
兼容的修复、UI 与文档调整修订版本 +11.4.2 → 1.4.3

版本说明结构 ​

每个 v{version}.md 参照历史版本的结构编写:

  • 版本信息(版本号、定位、发布日期);
  • 主要变更(后端 / 数据库 / 管理端 / 用户端);
  • 升级前准备;
  • 数据库升级命令;
  • 推荐部署顺序;
  • 验证命令与部署后检查清单;
  • 版本边界。

版本索引 ​

版本主题详情
v0.0.1基础框架首个可部署版本版本说明
v0.0.2插件化基础设施版本说明
v0.0.3会员用户体系与手机号脱敏版本说明