feat: 实现系统动态更新功能和 Release 创建脚本

主要变更:

1. 动态更新功能
   - 新增 Python 更新服务 (docker/update-service.py)
   - 添加系统更新前端页面 (frontend/src/pages/SystemUpdate.tsx)
   - 配置 Nginx 代理更新服务 API
   - 更新 Docker 启动脚本支持多进程管理
   - 修复权限验证接口 (AuthController.verify)

2. Release 创建脚本
   - 新增 create-release.sh 脚本支持快速创建 GitHub Release
   - 支持自动拼接 -beta 后缀(pre-release)
   - 支持无交互模式(--yes 参数)
   - 添加详细的使用文档

3. GitHub Actions 增强
   - 添加更新包构建和上传流程
   - 支持 Pre-release 检测和过滤

4. 文档完善
   - 添加动态更新技术方案文档
   - 添加 Docker 版本号确定流程文档
   - 添加 Release 脚本使用说明
This commit is contained in:
WrBug
2026-01-21 03:34:16 +08:00
parent 662aa47de6
commit 26dd3bb387
25 changed files with 4957 additions and 118 deletions
+324
View File
@@ -0,0 +1,324 @@
# Docker 版本号确定流程
## 概述
Docker 镜像的版本号从 **GitHub Release Tag** 获取,通过 GitHub Actions 自动传递到 Dockerfile,最终存储在容器内的 `/app/version.json` 文件中。
## 完整流程
```
1. GitHub Release Tag (v1.0.0)
2. GitHub Actions 触发
3. 从 Tag 提取版本号
4. 作为 build-args 传递给 Dockerfile
5. Dockerfile 写入 /app/version.json
6. 容器运行时读取版本号
```
## 详细步骤
### 步骤 1: 创建 GitHub Release
通过 GitHub Releases 页面或 `create-release.sh` 脚本创建 Release
```bash
# 示例:创建 v1.0.1 版本
./create-release.sh -t v1.0.1 -T "Release v1.0.1" -d "更新内容"
```
**结果**:
- 创建 Git tag: `v1.0.1`
- 创建 GitHub Release: `v1.0.1`
- 触发 GitHub Actions workflow
### 步骤 2: GitHub Actions 触发
GitHub Actions 监听 `release: published` 事件:
```yaml
# .github/workflows/docker-build.yml
on:
release:
types:
- published # 当创建 release 时触发
```
**事件数据**:
- `github.event.release.tag_name`: `"v1.0.1"`
- `github.event.release.prerelease`: `false``true`
### 步骤 3: 提取版本号
GitHub Actions 从 Tag 中提取版本号:
```bash
# .github/workflows/docker-build.yml (步骤: Extract version)
TAG_NAME="${{ github.event.release.tag_name }}" # "v1.0.1"
VERSION=${TAG_NAME#v} # "1.0.1" (移除 v 前缀)
```
**提取结果**:
- `VERSION`: `"1.0.1"` (纯版本号,无 v 前缀)
- `TAG`: `"v1.0.1"` (完整 tag,带 v 前缀)
- `IS_PRERELEASE`: `false``true`
**版本号格式验证**:
- ✅ 正确:`v1.0.0`, `v2.10.102`, `v1.0.0-beta`
- ❌ 错误:`v1.0`, `1.0.0`, `v1.0.0.1`
### 步骤 4: 传递构建参数
版本号作为 Docker build-args 传递给 Dockerfile
```yaml
# .github/workflows/docker-build.yml
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
build-args: |
BUILD_IN_DOCKER=false
VERSION=${{ steps.extract_version.outputs.VERSION }} # "1.0.1"
GIT_TAG=${{ steps.extract_version.outputs.TAG }} # "v1.0.1"
GITHUB_REPO_URL=https://github.com/WrBug/PolyHermes
```
### 步骤 5: Dockerfile 接收参数
Dockerfile 使用 ARG 接收构建参数:
```dockerfile
# Dockerfile (第 92-94 行)
ARG VERSION=dev # 默认值: dev
ARG GIT_TAG=dev # 默认值: dev
# 写入 version.json
RUN echo "{\"version\":\"${VERSION}\",\"tag\":\"${GIT_TAG}\",\"buildTime\":\"$(date -u +%Y-%m-%dT%H:%M:%SZ)\"}" > /app/version.json
```
**生成的文件内容** (`/app/version.json`):
```json
{
"version": "1.0.1",
"tag": "v1.0.1",
"buildTime": "2026-01-20T15:30:00Z"
}
```
### 步骤 6: 容器运行时读取
更新服务通过 `/api/update/version` 接口读取版本号:
```python
# docker/update-service.py
def get_current_version():
"""获取当前版本"""
if VERSION_FILE.exists():
with open(VERSION_FILE) as f:
data = json.load(f)
return data.get('version', 'unknown') # 返回: "1.0.1"
```
前端通过 API 获取并显示:
```typescript
// frontend/src/pages/SystemUpdate.tsx
const response = await apiClient.get('/update/version')
const { version } = response.data.data // "1.0.1"
```
## 不同场景下的版本号
### 场景 1: GitHub Actions 自动构建(正式发布)
**输入**:
- Release Tag: `v1.0.1`
- Release Type: Published (正式版本)
**流程**:
1. GitHub Actions 提取: `VERSION="1.0.1"`, `GIT_TAG="v1.0.1"`
2. 传递给 Dockerfile
3. 生成 `/app/version.json`: `{"version": "1.0.1", "tag": "v1.0.1", ...}`
**Docker 镜像标签**:
- `wrbug/polyhermes:v1.0.1`
- `wrbug/polyhermes:latest` ✅ (因为不是 pre-release)
### 场景 2: Pre-release(测试版本)
**输入**:
- Release Tag: `v1.0.1-beta`
- Release Type: Pre-release
**流程**:
1. GitHub Actions 提取: `VERSION="1.0.1-beta"`, `GIT_TAG="v1.0.1-beta"`
2. 传递给 Dockerfile
3. 生成 `/app/version.json`: `{"version": "1.0.1-beta", "tag": "v1.0.1-beta", ...}`
**Docker 镜像标签**:
- `wrbug/polyhermes:v1.0.1-beta`
- `wrbug/polyhermes:latest` ❌ (pre-release 不推送到 latest)
### 场景 3: 本地构建(开发环境)
**命令行**:
```bash
docker build -t polyhermes:local .
```
**流程**:
1. 没有传递 `VERSION``GIT_TAG` 参数
2. Dockerfile 使用默认值: `VERSION=dev`, `GIT_TAG=dev`
3. 生成 `/app/version.json`: `{"version": "dev", "tag": "dev", ...}`
**显式指定版本号**:
```bash
docker build \
--build-arg VERSION=1.0.1 \
--build-arg GIT_TAG=v1.0.1 \
-t polyhermes:local .
```
### 场景 4: 本地 Docker Compose
**docker-compose.yml**:
```yaml
services:
app:
build:
context: .
args:
VERSION: 1.0.1
GIT_TAG: v1.0.1
```
## 版本号存储位置
### 容器内路径
```
/app/version.json
```
### 文件格式
```json
{
"version": "1.0.1", // 纯版本号(无 v 前缀)
"tag": "v1.0.1", // 完整 tag(带 v 前缀)
"buildTime": "2026-01-20T15:30:00Z" // 构建时间(UTC
}
```
### 访问方式
**1. 通过 API**:
```bash
curl http://localhost/api/update/version
```
**2. 进入容器查看**:
```bash
docker exec -it <container_id> cat /app/version.json
```
**3. 前端显示**:
- 系统设置 → 系统更新页面
- 显示当前版本: `v1.0.1`
## 版本号的作用
### 1. 显示当前版本
前端和系统更新页面显示当前运行的版本号。
### 2. 检查更新
更新服务通过比较当前版本和 GitHub 最新版本判断是否有更新:
```python
# docker/update-service.py
current_version = get_current_version() # "1.0.1"
latest_version = fetch_latest_release() # "1.0.2"
if compare_versions(latest_version, current_version) > 0:
# 有新版本,提示更新
```
### 3. 版本追踪
记录 Docker 镜像的构建版本,便于追踪和回滚。
## 关键文件
| 文件 | 作用 | 版本号来源 |
|------|------|-----------|
| `.github/workflows/docker-build.yml` | GitHub Actions 工作流 | `github.event.release.tag_name` |
| `Dockerfile` | Docker 构建配置 | 构建参数 `VERSION`, `GIT_TAG` |
| `/app/version.json` | 版本号存储文件 | Dockerfile 生成 |
| `docker/update-service.py` | 更新服务 | 读取 `/app/version.json` |
## 常见问题
### Q1: 为什么版本号是 `dev`
**A**: 本地构建时没有传递版本号参数,使用了默认值。
**解决**:
```bash
docker build \
--build-arg VERSION=1.0.1 \
--build-arg GIT_TAG=v1.0.1 \
-t polyhermes:local .
```
### Q2: 如何查看当前容器的版本号?
**A**:
```bash
# 方法1: API 接口
curl http://localhost/api/update/version
# 方法2: 进入容器
docker exec -it <container_id> cat /app/version.json
# 方法3: 前端页面
系统设置 → 系统更新 → 查看"当前版本"
```
### Q3: 版本号格式错误怎么办?
**A**: GitHub Actions 会验证版本号格式:
- ✅ 正确:`v1.0.0`, `v1.0.0-beta`
- ❌ 错误:`v1.0`, `1.0.0`
如果格式错误,构建会失败并提示错误信息。
### Q4: Pre-release 和正式版本的版本号有什么区别?
**A**:
- **格式**: 都可以使用相同的格式(`v1.0.1-beta` vs `v1.0.1`
- **存储**: 都存储在 `/app/version.json`
- **Docker 标签**: Pre-release 不会推送到 `latest` 标签
- **通知**: Pre-release 不会发送 Telegram 通知
## 总结
Docker 版本号的确定流程:
1. **来源**: GitHub Release Tag
2. **提取**: GitHub Actions 从 tag 中提取版本号
3. **传递**: 通过 Docker build-args 传递
4. **存储**: 写入容器内的 `/app/version.json`
5. **使用**: 用于显示、检查更新、版本追踪
关键点:
- ✅ 版本号来自 **GitHub Release Tag**
- ✅ 格式必须符合:`v数字.数字.数字[-后缀]`
- ✅ 默认值为 `dev`(本地构建时)
- ✅ 支持 Pre-release 标记
File diff suppressed because it is too large Load Diff
+208
View File
@@ -0,0 +1,208 @@
# 动态更新功能实现检查报告
基于 `docs/zh/DYNAMIC_UPDATE.md` 文档和现有代码,检查动态更新功能的实现情况。
## ✅ 已实现的功能
### 1. 后端更新服务
-`docker/update-service.py` 已实现
- 检查更新:`GET /check`
- 执行更新:`POST /update`
- 更新状态:`GET /status`
- 更新日志:`GET /logs`
- 获取版本:`GET /version`
- 健康检查:`GET /health`
- Pre-release 支持:通过 `ALLOW_PRERELEASE` 环境变量控制
### 2. Nginx 配置
-`docker/nginx.conf` 已配置
- `/api/update/` 路径代理到 `http://localhost:9090/`
- 正确传递 Authorization 头
- 超时设置合理(300秒)
### 3. Docker 启动脚本
-`docker/start.sh` 已实现
- 启动更新服务(端口 9090
- 启动后端服务(端口 8000
- 启动 Nginx(前台运行)
- 正确的进程清理逻辑
### 4. Dockerfile
-`Dockerfile` 已配置
- 安装 Python 和 Flask
- 复制更新服务脚本
- 创建必要的目录
- 支持混合编译方案(`BUILD_IN_DOCKER` 参数)
### 5. GitHub Actions
-`.github/workflows/docker-build.yml` 已配置
- 构建后端 JAR
- 构建前端
- 打包更新包
- 计算校验和
- 上传到 Release Assets
- Pre-release 检测和过滤
### 6. 前端更新界面
-`frontend/src/pages/SystemUpdate.tsx` 已实现
- 显示当前版本
- 检查更新
- 显示更新信息
- 执行更新
- 更新进度显示
- 错误处理
### 7. 权限验证端点
-`/api/auth/verify` 端点已存在
- 位置:`backend/src/main/kotlin/com/wrbug/polymarketbot/controller/auth/AuthController.kt`
## ⚠️ 发现的问题
### 问题 1: `/api/auth/verify` 接口逻辑错误
**位置**: `backend/src/main/kotlin/com/wrbug/polymarketbot/controller/auth/AuthController.kt:192-212`
**问题**:
```kotlin
// 检查是否为管理员
val role = httpRequest.getAttribute("role") as? String
if (role != "ADMIN") {
return ResponseEntity.status(403).body(...)
}
```
**原因**:
1. JWT 拦截器(`JwtAuthenticationInterceptor`)只设置了 `username` 到 request attributes**没有设置 `role`**
2. User 实体**没有 `role` 字段**,而是使用 `isDefault` 字段来判断是否为管理员(默认账户就是管理员)
**修复方案**:
需要修改 `/api/auth/verify` 接口,检查用户是否为默认账户:
```kotlin
@GetMapping("/verify")
fun verify(httpRequest: HttpServletRequest): ResponseEntity<ApiResponse<Unit>> {
return try {
val username = httpRequest.getAttribute("username") as? String
if (username == null) {
return ResponseEntity.status(401).body(ApiResponse.error(ErrorCode.AUTH_ERROR, "未认证", messageSource))
}
// 检查是否为默认账户(管理员)
val user = userRepository.findByUsername(username)
if (user == null || !user.isDefault) {
return ResponseEntity.status(403).body(ApiResponse.error(ErrorCode.AUTH_ERROR, "需要管理员权限", messageSource))
}
ResponseEntity.ok(ApiResponse.success(Unit))
} catch (e: Exception) {
logger.error("验证权限异常: ${e.message}", e)
ResponseEntity.status(500).body(ApiResponse.error(ErrorCode.SERVER_ERROR, "验证失败", messageSource))
}
}
```
**需要的依赖**:
-`AuthController` 中注入 `UserRepository`
### 问题 2: 前端 SystemUpdate 组件未使用 apiClient
**位置**: `frontend/src/pages/SystemUpdate.tsx`
**问题**:
组件使用了原生的 `fetch` API,而不是项目统一的 `apiClient`。虽然 `apiClient` 有拦截器自动添加 Authorization header,但原生 `fetch` 不会自动添加。
**当前代码**:
```typescript
const response = await fetch('/api/update/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
}
})
```
**修复方案**:
有两种方案:
**方案 1(推荐)**: 使用 `apiClient`
```typescript
import { apiClient } from '../services/api'
const response = await apiClient.post('/update/execute', {})
```
**方案 2**: 手动添加 Authorization header
```typescript
const token = localStorage.getItem('token')
const response = await fetch('/api/update/execute', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${token}`
}
})
```
**影响**:
- 当前如果用户已登录,token 在 localStorage 中,Nginx 会传递 Authorization 头
- 但使用 `apiClient` 更统一,且可以处理 token 刷新等情况
## 📋 已修复的问题
### 后端 ✅
1. ✅ 已修复 `AuthController.verify()` 方法
- ✅ 移除了错误的 `role` 检查
- ✅ 添加了 `UserRepository` 依赖注入
- ✅ 正确检查用户是否为默认账户(`isDefault == true`
### 前端 ✅
2. ✅ 已修复 `SystemUpdate.tsx` 组件
- ✅ 将所有 `fetch` 调用替换为 `apiClient`
- ✅ 确保自动携带 Authorization header
- ✅ 统一错误处理逻辑
## ✅ 其他检查项
### 更新服务功能完整性
- ✅ 检查更新(无需权限)
- ✅ 获取版本(无需权限)
- ✅ 执行更新(需要管理员权限)
- ✅ 获取日志(需要管理员权限)
- ✅ 获取状态(无需权限)
### 更新流程完整性
- ✅ 下载更新包
- ✅ 备份当前版本
- ✅ 替换文件
- ✅ 重启后端
- ✅ 健康检查
- ✅ 自动回滚
### 文档完整性
- ✅ 技术方案文档存在
- ✅ 架构设计清晰
- ✅ 使用流程说明完整
## 📝 总结
**整体实现度**: 100% ✅
**已修复的问题**:
1.`/api/auth/verify` 接口已修复(现在正确检查默认账户而非 role)
2. ✅ 前端组件已改用 `apiClient` 保持一致性
**功能状态**:
- ✅ 所有核心功能已实现
- ✅ 所有问题已修复
- ✅ 代码质量良好,无 lint 错误
**下一步**:
1. 进行集成测试,验证更新流程端到端是否正常工作
2. 测试权限验证是否生效(非管理员用户应无法执行更新)
---
**检查日期**: 2026-01-20
**最后更新**: 2026-01-20(已修复所有问题)
**检查人**: AI Assistant
+112
View File
@@ -0,0 +1,112 @@
# PolyHermes 动态更新功能实施完成
## ✅ 已完成的文件修改
### 1. Docker 相关
-`Dockerfile` - 混合编译方案(BUILD_IN_DOCKER 参数)
-`docker/update-service.py` - Python 更新服务
-`docker/start.sh` - 启动脚本(启动3个进程)
-`docker/nginx.conf` - Nginx 代理配置(/api/update/
-`docker-compose.yml` - 添加环境变量(ALLOW_PRERELEASE, GITHUB_REPO
-`docker-compose.test.yml` - 测试环境配置
### 2. GitHub Actions
-`.github/workflows/docker-build.yml` - 完整更新
- Pre-release 检测
- 前后端编译
- 更新包打包和上传
- Docker 构建(BUILD_IN_DOCKER=false
- 条件化 Telegram 通知
### 3. 文档
-`docs/zh/DYNAMIC_UPDATE.md` - 完整技术文档
## 📋 实施清单
| 文件 | 状态 | 说明 |
|------|------|------|
| Dockerfile | ✅ 完成 | 混合编译方案 |
| docker/update-service.py | ✅ 完成 | 更新服务(Flask) |
| docker/start.sh | ✅ 完成 | 启动3个进程 |
| docker/nginx.conf | ✅ 完成 | 代理配置 |
| docker-compose.yml | ✅ 完成 | 环境变量 |
| docker-compose.test.yml | ✅ 完成 | 测试环境 |
| .github/workflows/docker-build.yml | ✅ 完成 | CI/CD 完整流程 |
| docs/zh/DYNAMIC_UPDATE.md | ✅ 完成 | 技术文档 |
## 🚀 下一步
### 测试流程
1. **本地测试**
```bash
# 本地构建测试
./deploy.sh
```
2. **Pre-release 测试**
```bash
# 创建测试 tag
git tag v1.3.0-beta
git push origin v1.3.0-beta
# GitHub 创建 Pre-release
# GitHub Actions 会自动:
# - 构建更新包
# - 上传到 Release
# - 构建 Docker 镜像(仅 tag
# - 不发送 Telegram
```
3. **生产发布**
```bash
# 创建正式 tag
git tag v1.3.0
git push origin v1.3.0
# GitHub 创建正式 Release
# GitHub Actions 会自动:
# - 构建更新包
# - 上传到 Release
# - 构建 Docker 镜像(tag + latest
# - 发送 Telegram 通知
```
## ⚠️ 注意事项
1. **首次发布需要包含前端代码**
- 需要先创建一个包含前端 UI 的 PR
- 实现 SystemUpdate 页面(React 组件)
- 路由、菜单等集成
2. **健康检查端点**
- 确保 `/api/system/health` 端点存在
- 如果不存在,需要修改 `start.sh` 和 `Dockerfile` 中的健康检查URL
3. **权限验证端点**
- 确保 `/api/auth/verify` 端点存在
- 或修改 `update-service.py` 中的权限验证逻辑
## 📝 待办事项
- [ ] 创建前端 SystemUpdate 页面
- [ ] 集成到系统设置菜单
- [ ] 测试本地构建流程
- [ ] 创建第一个 Pre-release 测试
- [ ] 验证更新流程
- [ ] 生产环境发布
## 🎯 核心特性
**混合编译** - GitHub Actions 快速(8分钟),本地兼容
**Pre-release 支持** - 测试环境完全隔离
**Nginx 直接代理** - 无需后端 Controller
**自动回滚** - 更新失败自动恢复
**进程独立** - 更新服务与主应用分离
**版本追踪** - /app/version.json 记录
**权限控制** - 管理员权限验证
---
**实施完成时间**: 2026-01-21
**技术方案版本**: v1.0