1
0

feat: 版本管理,package.json 唯一版本源、/api/meta 返回版本、Dashboard Header 展示版本号

This commit is contained in:
2026-05-20 19:14:37 +08:00
parent f3df3a203b
commit 8eac814cc6
25 changed files with 490 additions and 20 deletions

View File

@@ -6,6 +6,7 @@
## 目录
- [版本管理](#版本管理)
- [项目结构](#项目结构)
- [一、后端开发指引](#一后端开发指引)
- [二、前端开发指引](#二前端开发指引)
@@ -15,6 +16,33 @@
---
## 版本管理
DiAL 使用 `package.json.version` 作为应用版本号的唯一来源,遵循 SemVer 语义化版本规范(`MAJOR.MINOR.PATCH`)。
**版本升迁命令:**
| 命令 | 说明 |
| ------------------------------- | ------------------------------------------------- |
| `bun run version:patch` | 升迁 patch 版本bugfix、文档、测试、内部重构 |
| `bun run version:minor` | 升迁 minor 版本(新功能、新 checker、新配置字段 |
| `bun run version:major` | 升迁 major 版本不兼容的配置格式、API 行为变化) |
| `bun run version:set <version>` | 显式设置版本号 |
**版本展示:**
- Dashboard Header 品牌区域展示当前运行实例版本号(如 `v0.1.0`
- 版号通过 `/api/meta` 接口返回,前端通过 `useMeta` hook 获取
- 生产构建时版本号固化到可执行文件中,不依赖运行时外部 `package.json`
**暂不支持:**
- CLI `--version` 参数
- 自动创建 git commit、git tag 或 changelog
- prerelease 版本格式(如 `1.0.0-beta.1`
---
## 项目结构
```text
@@ -27,6 +55,7 @@ src/
server.ts HTTP server 启动工厂Bun.serve routes 声明式路由 + fetch fallback 静态资源服务)
helpers.ts 共享响应格式化工具(见下方函数清单)
middleware.ts API 参数校验中间件validateTargetId、validateTimeRange、validatePagination
version.ts 应用版本读取与校验
routes/ API 路由 handler按端点拆分
health.ts GET /health无 store 参数)
meta.ts GET /api/meta