chore: import upstream snapshot with attribution
This commit is contained in:
@@ -0,0 +1,164 @@
|
||||
# 自动版本发布指南
|
||||
|
||||
## 📋 概述
|
||||
|
||||
本项目配置了自动版本发布功能,每次推送到 `main` 分支时会自动递增版本号并创建 GitHub Release。
|
||||
|
||||
## 🚀 工作原理
|
||||
|
||||
### 自动版本递增规则
|
||||
|
||||
- **版本格式**: `v<major>.<minor>.<patch>` (例如: v1.0.2)
|
||||
- **递增规则**: 每次推送到 main 分支,自动递增 patch 版本号
|
||||
- v1.0.1 → v1.0.2
|
||||
- v1.0.9 → v1.0.10
|
||||
- v1.0.99 → v1.0.100
|
||||
|
||||
### 触发条件
|
||||
|
||||
当满足以下条件时,会自动创建新版本:
|
||||
|
||||
1. 推送到 `main` 分支
|
||||
2. 有实际的代码变更(不包括纯文档更新)
|
||||
3. 自上次发布以来有新的提交
|
||||
|
||||
## 📝 使用方法
|
||||
|
||||
### 1. 常规开发流程
|
||||
|
||||
```bash
|
||||
# 在 dev 分支开发
|
||||
git checkout dev
|
||||
# ... 进行开发 ...
|
||||
git add .
|
||||
git commit -m "feat: 添加新功能"
|
||||
git push origin dev
|
||||
|
||||
# 合并到 main 分支
|
||||
git checkout main
|
||||
git merge dev
|
||||
git push origin main # 这会触发自动发布
|
||||
```
|
||||
|
||||
### 2. 跳过自动发布
|
||||
|
||||
如果你的提交不想触发自动发布,在 commit 消息中添加 `[skip ci]`:
|
||||
|
||||
```bash
|
||||
git commit -m "docs: 更新文档 [skip ci]"
|
||||
```
|
||||
|
||||
### 3. 手动控制版本号
|
||||
|
||||
如果需要发布大版本或中版本更新:
|
||||
|
||||
```bash
|
||||
# 大版本更新 (1.0.x → 2.0.0)
|
||||
git tag -a v2.0.0 -m "Major release v2.0.0"
|
||||
git push origin v2.0.0
|
||||
|
||||
# 中版本更新 (1.0.x → 1.1.0)
|
||||
git tag -a v1.1.0 -m "Minor release v1.1.0"
|
||||
git push origin v1.1.0
|
||||
```
|
||||
|
||||
## 🔧 配置说明
|
||||
|
||||
### 工作流文件
|
||||
|
||||
- **位置**: `.github/workflows/auto-release.yml`
|
||||
- **功能**:
|
||||
- 获取最新版本标签
|
||||
- 计算下一个版本号
|
||||
- 生成 changelog
|
||||
- 创建 GitHub Release
|
||||
- 更新 CHANGELOG.md 文件
|
||||
- 发送 Telegram 通知(可选)
|
||||
|
||||
### Changelog 生成
|
||||
|
||||
使用 [git-cliff](https://github.com/orhun/git-cliff) 自动生成更新日志:
|
||||
|
||||
- **配置文件**: `.github/cliff.toml`
|
||||
- **提交规范**: 遵循 [Conventional Commits](https://www.conventionalcommits.org/)
|
||||
- `feat:` 新功能
|
||||
- `fix:` Bug 修复
|
||||
- `docs:` 文档更新
|
||||
- `chore:` 其他变更
|
||||
- `refactor:` 代码重构
|
||||
- `perf:` 性能优化
|
||||
|
||||
## 📊 查看发布历史
|
||||
|
||||
1. **GitHub Releases 页面**:
|
||||
- 访问 `https://github.com/<owner>/<repo>/releases`
|
||||
- 查看所有发布版本和更新内容
|
||||
|
||||
2. **CHANGELOG.md**:
|
||||
- 项目根目录的 `CHANGELOG.md` 文件
|
||||
- 包含完整的版本历史
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### Q: 如何查看当前版本?
|
||||
|
||||
```bash
|
||||
# 查看最新标签
|
||||
git describe --tags --abbrev=0
|
||||
|
||||
# 查看所有标签
|
||||
git tag -l
|
||||
```
|
||||
|
||||
### Q: 自动发布失败怎么办?
|
||||
|
||||
1. 检查 GitHub Actions 日志
|
||||
2. 确认是否有权限创建标签和发布
|
||||
3. 检查是否有语法错误
|
||||
|
||||
### Q: 如何回滚版本?
|
||||
|
||||
自动发布只是创建标签和 Release,不会影响代码:
|
||||
|
||||
```bash
|
||||
# 回滚到特定版本
|
||||
git checkout v1.0.1
|
||||
|
||||
# 或者使用 Docker 镜像的特定版本
|
||||
docker pull weishaw/claude-relay-service:v1.0.1
|
||||
```
|
||||
|
||||
### Q: 如何修改版本递增规则?
|
||||
|
||||
编辑 `.github/workflows/auto-release.yml` 中的版本计算逻辑:
|
||||
|
||||
```yaml
|
||||
# 当前是递增 patch 版本
|
||||
NEW_PATCH=$((PATCH + 1))
|
||||
|
||||
# 可以改为递增 minor 版本
|
||||
NEW_MINOR=$((MINOR + 1))
|
||||
NEW_PATCH=0
|
||||
```
|
||||
|
||||
## 📱 Telegram 通知(可选)
|
||||
|
||||
自动发布系统支持发送通知到 Telegram 频道。配置后,每次发布新版本都会自动发送通知。
|
||||
|
||||
### 快速设置
|
||||
|
||||
1. 创建 Telegram Bot(通过 @BotFather)
|
||||
2. 将 Bot 添加到频道作为管理员
|
||||
3. 获取频道的 Chat ID
|
||||
4. 在 GitHub 仓库添加 Secrets:
|
||||
- `TELEGRAM_BOT_TOKEN`
|
||||
- `TELEGRAM_CHAT_ID`
|
||||
|
||||
详细设置步骤请参考 [Telegram 通知设置指南](./TELEGRAM_SETUP.md)
|
||||
|
||||
## 🔗 相关链接
|
||||
|
||||
- [GitHub Actions 工作流使用指南](./WORKFLOW_USAGE.md)
|
||||
- [Telegram 通知设置指南](./TELEGRAM_SETUP.md)
|
||||
- [Docker Hub 设置指南](./DOCKER_HUB_SETUP.md)
|
||||
- [Git Cliff 配置文档](https://git-cliff.org/docs/configuration)
|
||||
@@ -0,0 +1,109 @@
|
||||
# Docker Hub 自动发布配置指南
|
||||
|
||||
本文档说明如何配置 GitHub Actions 自动构建并发布 Docker 镜像到 Docker Hub。
|
||||
|
||||
## 📋 前置要求
|
||||
|
||||
1. Docker Hub 账号
|
||||
2. GitHub 仓库的管理员权限
|
||||
|
||||
## 🔐 配置 GitHub Secrets
|
||||
|
||||
在 GitHub 仓库中配置以下 secrets:
|
||||
|
||||
1. 进入仓库设置:`Settings` → `Secrets and variables` → `Actions`
|
||||
2. 点击 `New repository secret`
|
||||
3. 添加以下 secrets:
|
||||
|
||||
### 必需的 Secrets
|
||||
|
||||
| Secret 名称 | 说明 | 如何获取 |
|
||||
|------------|------|---------|
|
||||
| `DOCKERHUB_USERNAME` | Docker Hub 用户名 | 你的 Docker Hub 登录用户名 |
|
||||
| `DOCKERHUB_TOKEN` | Docker Hub Access Token | 见下方说明 |
|
||||
|
||||
### 获取 Docker Hub Access Token
|
||||
|
||||
1. 登录 [Docker Hub](https://hub.docker.com/)
|
||||
2. 点击右上角头像 → `Account Settings`
|
||||
3. 选择 `Security` → `Access Tokens`
|
||||
4. 点击 `New Access Token`
|
||||
5. 填写描述(如:`GitHub Actions`)
|
||||
6. 选择权限:`Read, Write, Delete`
|
||||
7. 点击 `Generate`
|
||||
8. **立即复制 token**(只显示一次)
|
||||
|
||||
## 🚀 工作流程说明
|
||||
|
||||
### 触发条件
|
||||
|
||||
- **自动触发**:推送到 `main` 分支
|
||||
- **版本发布**:创建 `v*` 格式的 tag(如 `v1.0.0`)
|
||||
- **手动触发**:在 Actions 页面手动运行
|
||||
|
||||
### 镜像标签策略
|
||||
|
||||
工作流会自动创建以下标签:
|
||||
|
||||
- `latest`:始终指向 main 分支的最新构建
|
||||
- `main`:main 分支的构建
|
||||
- `v1.0.0`:版本标签(当创建 tag 时)
|
||||
- `1.0`:主次版本标签
|
||||
- `1`:主版本标签
|
||||
- `main-sha-xxxxxxx`:包含 commit SHA 的标签
|
||||
|
||||
### 支持的平台
|
||||
|
||||
- `linux/amd64`:Intel/AMD 架构
|
||||
- `linux/arm64`:ARM64 架构(如 Apple Silicon, 树莓派等)
|
||||
|
||||
## 📦 使用发布的镜像
|
||||
|
||||
```bash
|
||||
# 拉取最新版本
|
||||
docker pull weishaw/claude-relay-service:latest
|
||||
|
||||
# 拉取特定版本
|
||||
docker pull weishaw/claude-relay-service:v1.0.0
|
||||
|
||||
# 运行容器
|
||||
docker run -d \
|
||||
--name claude-relay \
|
||||
-p 3000:3000 \
|
||||
-v ./data:/app/data \
|
||||
-v ./logs:/app/logs \
|
||||
-e ADMIN_USERNAME=my_admin \
|
||||
-e ADMIN_PASSWORD=my_password \
|
||||
weishaw/claude-relay-service:latest
|
||||
```
|
||||
|
||||
## 🔍 验证配置
|
||||
|
||||
1. 推送代码到 main 分支
|
||||
2. 在 GitHub 仓库页面点击 `Actions` 标签
|
||||
3. 查看 `Docker Build & Push` 工作流运行状态
|
||||
4. 成功后在 Docker Hub 查看镜像
|
||||
|
||||
## 🛡️ 安全功能
|
||||
|
||||
- **漏洞扫描**:使用 Trivy 自动扫描镜像漏洞
|
||||
- **扫描报告**:上传到 GitHub Security 标签页
|
||||
- **自动更新 README**:同步更新 Docker Hub 的项目描述
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### 构建失败
|
||||
|
||||
- 检查 secrets 是否正确配置
|
||||
- 确认 Docker Hub token 有足够权限
|
||||
- 查看 Actions 日志详细错误信息
|
||||
|
||||
### 镜像推送失败
|
||||
|
||||
- 确认 Docker Hub 用户名正确
|
||||
- 检查是否达到 Docker Hub 免费账户限制
|
||||
- Token 可能过期,需要重新生成
|
||||
|
||||
### 多平台构建慢
|
||||
|
||||
这是正常的,因为需要模拟不同架构。可以在不需要时修改 `platforms` 配置。
|
||||
@@ -0,0 +1,12 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: # Your GitHub username for GitHub Sponsors
|
||||
patreon: # Replace with your Patreon username if you have one
|
||||
open_collective: # Replace with your Open Collective username if you have one
|
||||
ko_fi: # Replace with your Ko-fi username if you have one
|
||||
tidelift: # Replace with your Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with your Community Bridge project-name
|
||||
liberapay: # Replace with your Liberapay username
|
||||
issuehunt: # Replace with your IssueHunt username
|
||||
otechie: # Replace with your Otechie username
|
||||
custom: ['https://afdian.com/a/claude-relay-service'] # Your custom donation link (Afdian)
|
||||
@@ -0,0 +1,94 @@
|
||||
# 发布流程说明
|
||||
|
||||
## 概述
|
||||
|
||||
本项目采用全自动化的版本管理和发布流程。VERSION文件由GitHub Actions自动维护,无需手动修改。
|
||||
|
||||
## 自动发布流程
|
||||
|
||||
### 1. 工作原理
|
||||
|
||||
1. **代码推送**: 当你推送代码到main分支时
|
||||
2. **自动版本更新**: `auto-version-bump.yml`会:
|
||||
- 检测是否有实质性代码变更(排除.md文件、docs/目录等)
|
||||
- 如果有代码变更,自动将版本号+1并更新VERSION文件
|
||||
- 提交VERSION文件更新到main分支
|
||||
3. **自动发布**: `release-on-version.yml`会:
|
||||
- 检测到只有VERSION文件变更的提交
|
||||
- 自动创建Git tag
|
||||
- 创建GitHub Release
|
||||
- 构建并推送Docker镜像
|
||||
- 发送Telegram通知(如果配置)
|
||||
|
||||
### 2. 工作流文件说明
|
||||
|
||||
- **auto-version-bump.yml**: 自动检测代码变更并更新VERSION文件
|
||||
- **release-on-version.yml**: 检测VERSION文件单独提交并触发发布
|
||||
- **docker-publish.yml**: 在tag创建时构建Docker镜像(备用)
|
||||
- **release.yml**: 在tag创建时生成Release(备用)
|
||||
|
||||
### 3. 版本号规范
|
||||
|
||||
- 使用语义化版本号:`MAJOR.MINOR.PATCH`
|
||||
- 默认自动递增PATCH版本(例如:1.1.10 → 1.1.11)
|
||||
- VERSION文件只包含版本号,不包含`v`前缀
|
||||
- Git tag会自动添加`v`前缀
|
||||
|
||||
### 4. 触发条件
|
||||
|
||||
**会触发版本更新的文件变更**:
|
||||
- 源代码文件(.js, .ts, .jsx, .tsx等)
|
||||
- 配置文件(package.json, Dockerfile等)
|
||||
- 其他功能性文件
|
||||
|
||||
**不会触发版本更新的文件变更**:
|
||||
- Markdown文件(*.md)
|
||||
- 文档目录(docs/)
|
||||
- GitHub配置(.github/)
|
||||
- VERSION文件本身
|
||||
- .gitignore、LICENSE等
|
||||
|
||||
## 使用指南
|
||||
|
||||
### 正常开发流程
|
||||
|
||||
1. 进行代码开发和修改
|
||||
2. 提交并推送到main分支
|
||||
3. 系统自动完成版本更新和发布
|
||||
|
||||
```bash
|
||||
# 正常的开发流程
|
||||
git add .
|
||||
git commit -m "feat: 添加新功能"
|
||||
git push origin main
|
||||
|
||||
# GitHub Actions会自动:
|
||||
# 1. 检测到代码变更
|
||||
# 2. 更新VERSION文件(例如:1.1.10 → 1.1.11)
|
||||
# 3. 创建新的release和Docker镜像
|
||||
```
|
||||
|
||||
### 跳过版本更新
|
||||
|
||||
如果只是更新文档或其他非代码文件,系统会自动识别并跳过版本更新。
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 版本没有自动更新
|
||||
|
||||
1. 检查是否有实质性代码变更
|
||||
2. 查看GitHub Actions运行日志
|
||||
3. 确认推送的是main分支
|
||||
|
||||
### 需要手动触发发布
|
||||
|
||||
如果需要手动控制版本:
|
||||
1. 直接修改VERSION文件
|
||||
2. 提交并推送
|
||||
3. 系统会检测到VERSION变更并触发发布
|
||||
|
||||
## 注意事项
|
||||
|
||||
- **不要**在同一个提交中既修改代码又修改VERSION文件
|
||||
- **不要**手动创建tag,让系统自动管理
|
||||
- 系统会自动避免死循环(GitHub Actions的提交不会触发新的版本更新)
|
||||
@@ -0,0 +1,110 @@
|
||||
# Telegram 自动通知设置指南
|
||||
|
||||
## 📋 概述
|
||||
|
||||
当 GitHub Actions 自动发布新版本时,系统会自动发送通知到你的 Telegram 频道。
|
||||
|
||||
## 🚀 设置步骤
|
||||
|
||||
### 1. 创建 Telegram Bot
|
||||
|
||||
1. 在 Telegram 中找到 [@BotFather](https://t.me/botfather)
|
||||
2. 发送 `/newbot` 命令
|
||||
3. 按提示设置 Bot 名称(例如:Claude Relay Updates)
|
||||
4. 设置 Bot 用户名(例如:claude_relay_bot)
|
||||
5. **保存 Bot Token**(格式类似:`1234567890:ABCdefGHIjklMNOpqrsTUVwxyz`)
|
||||
|
||||
### 2. 创建或选择 Telegram 频道
|
||||
|
||||
1. 创建一个新频道或使用现有频道
|
||||
2. 将你的 Bot 添加为频道管理员:
|
||||
- 进入频道设置
|
||||
- 管理员 → 添加管理员
|
||||
- 搜索你的 Bot 用户名
|
||||
- 赋予发送消息权限
|
||||
|
||||
### 3. 获取频道 Chat ID
|
||||
|
||||
有几种方法获取频道的 Chat ID:
|
||||
|
||||
#### 方法 1:使用 Web Telegram
|
||||
1. 打开 https://web.telegram.org
|
||||
2. 进入你的频道
|
||||
3. 查看 URL,格式为:`https://web.telegram.org/k/#-1234567890`
|
||||
4. Chat ID 就是 `#` 后面的数字(包括负号):`-1234567890`
|
||||
|
||||
#### 方法 2:使用 Bot API
|
||||
1. 先在频道发送一条消息
|
||||
2. 访问:`https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates`
|
||||
3. 找到你的频道消息,查看 `chat.id` 字段
|
||||
|
||||
#### 方法 3:使用频道用户名
|
||||
如果频道是公开的,可以直接使用 `@频道用户名` 作为 Chat ID
|
||||
|
||||
### 4. 添加 GitHub Secrets
|
||||
|
||||
1. 访问你的 GitHub 仓库
|
||||
2. 进入 Settings → Secrets and variables → Actions
|
||||
3. 点击 "New repository secret"
|
||||
4. 添加以下两个 Secrets:
|
||||
|
||||
**TELEGRAM_BOT_TOKEN**
|
||||
- Name: `TELEGRAM_BOT_TOKEN`
|
||||
- Value: 你的 Bot Token(例如:`1234567890:ABCdefGHIjklMNOpqrsTUVwxyz`)
|
||||
|
||||
**TELEGRAM_CHAT_ID**
|
||||
- Name: `TELEGRAM_CHAT_ID`
|
||||
- Value: 你的频道 Chat ID(例如:`-1234567890` 或 `@your_channel`)
|
||||
|
||||
## ✅ 测试配置
|
||||
|
||||
配置完成后,下次推送到 main 分支时,你的 Telegram 频道将收到类似这样的通知:
|
||||
|
||||
```
|
||||
🚀 Claude Relay Service 新版本发布!
|
||||
|
||||
📦 版本号: 1.1.3
|
||||
|
||||
📝 更新内容:
|
||||
- feat: 添加 Telegram 自动通知功能
|
||||
- fix: 修复某个问题
|
||||
|
||||
🐳 Docker 部署:
|
||||
docker pull weishaw/claude-relay-service:v1.1.3
|
||||
docker pull weishaw/claude-relay-service:latest
|
||||
|
||||
🔗 相关链接:
|
||||
• GitHub Release
|
||||
• 完整更新日志
|
||||
• Docker Hub
|
||||
|
||||
#ClaudeRelay #Update #v1_1_3
|
||||
```
|
||||
|
||||
## 🔧 自定义通知
|
||||
|
||||
如果你想修改通知格式,编辑 `.github/workflows/auto-release.yml` 中的 `Send Telegram Notification` 步骤。
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### Q: 通知发送失败怎么办?
|
||||
|
||||
检查:
|
||||
1. Bot Token 是否正确
|
||||
2. Bot 是否已添加为频道管理员
|
||||
3. Chat ID 是否正确(注意负号)
|
||||
4. GitHub Secrets 是否正确配置
|
||||
|
||||
### Q: 可以发送到多个频道吗?
|
||||
|
||||
可以修改工作流,添加多个通知步骤,或使用逗号分隔多个 Chat ID。
|
||||
|
||||
### Q: 通知失败会影响版本发布吗?
|
||||
|
||||
不会。通知步骤配置了 `continue-on-error: true`,即使通知失败也不会影响版本发布。
|
||||
|
||||
## 🔐 安全提示
|
||||
|
||||
- **永远不要**在代码中直接写入 Bot Token
|
||||
- 始终使用 GitHub Secrets 存储敏感信息
|
||||
- 定期更换 Bot Token 以保证安全
|
||||
@@ -0,0 +1,129 @@
|
||||
# GitHub Actions 工作流使用指南
|
||||
|
||||
## 📋 概述
|
||||
|
||||
本项目配置了自动化 CI/CD 流程,每次推送到 main 分支都会自动构建并发布 Docker 镜像到 Docker Hub。
|
||||
|
||||
## 🚀 工作流程
|
||||
|
||||
### 1. Docker 构建和发布 (`docker-publish.yml`)
|
||||
|
||||
**功能:**
|
||||
- 自动构建多平台 Docker 镜像(amd64, arm64)
|
||||
- 推送到 Docker Hub
|
||||
- 执行安全漏洞扫描
|
||||
- 更新 Docker Hub 描述
|
||||
|
||||
**触发条件:**
|
||||
- 推送到 `main` 分支
|
||||
- 创建版本标签(如 `v1.0.0`)
|
||||
- Pull Request(仅构建,不推送)
|
||||
- 手动触发
|
||||
|
||||
### 2. 发布管理 (`release.yml`)
|
||||
|
||||
**功能:**
|
||||
- 自动创建 GitHub Release
|
||||
- 生成更新日志
|
||||
- 关联 Docker 镜像版本
|
||||
|
||||
**触发条件:**
|
||||
- 创建版本标签(如 `v1.0.0`)
|
||||
|
||||
### 3. 自动版本发布 (`auto-release.yml`)
|
||||
|
||||
**功能:**
|
||||
- 自动递增版本号(patch 版本)
|
||||
- 自动创建版本标签
|
||||
- 生成 GitHub Release
|
||||
- 更新 CHANGELOG.md
|
||||
|
||||
**触发条件:**
|
||||
- 推送到 `main` 分支(自动触发)
|
||||
- 忽略纯文档更新
|
||||
|
||||
## 📝 版本发布流程
|
||||
|
||||
### 1. 常规更新(推送到 main)
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "fix: 修复登录问题"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
**结果:**
|
||||
- 自动构建并推送 `latest` 标签到 Docker Hub
|
||||
- 更新 `main` 标签
|
||||
- **自动递增版本号并创建 Release**(例如:v1.0.1 → v1.0.2)
|
||||
- 生成更新日志
|
||||
|
||||
### 2. 版本发布
|
||||
|
||||
```bash
|
||||
# 创建版本标签
|
||||
git tag -a v1.0.0 -m "Release version 1.0.0"
|
||||
git push origin v1.0.0
|
||||
```
|
||||
|
||||
**结果:**
|
||||
- 构建并推送以下标签到 Docker Hub:
|
||||
- `v1.0.0`(完整版本)
|
||||
- `1.0`(主次版本)
|
||||
- `1`(主版本)
|
||||
- `latest`(最新版本)
|
||||
- 创建 GitHub Release
|
||||
- 生成更新日志
|
||||
|
||||
## 🔧 手动触发构建
|
||||
|
||||
1. 访问仓库的 Actions 页面
|
||||
2. 选择 "Docker Build & Push" 工作流
|
||||
3. 点击 "Run workflow"
|
||||
4. 选择分支并运行
|
||||
|
||||
## 📊 查看构建状态
|
||||
|
||||
- **Actions 页面**:查看所有工作流运行历史
|
||||
- **README 徽章**:实时显示构建状态
|
||||
- **Docker Hub**:查看镜像标签和拉取次数
|
||||
|
||||
## 🛡️ 安全扫描
|
||||
|
||||
每次构建都会运行 Trivy 安全扫描:
|
||||
- 扫描结果上传到 GitHub Security 标签页
|
||||
- 发现高危漏洞会在 Actions 日志中警告
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### Q: 如何回滚到之前的版本?
|
||||
|
||||
```bash
|
||||
# 使用特定版本标签
|
||||
docker pull weishaw/claude-relay-service:v1.0.0
|
||||
|
||||
# 或在 docker-compose.yml 中指定版本
|
||||
image: weishaw/claude-relay-service:v1.0.0
|
||||
```
|
||||
|
||||
### Q: 如何跳过自动构建?
|
||||
|
||||
在 commit 消息中添加 `[skip ci]`:
|
||||
```bash
|
||||
git commit -m "docs: 更新文档 [skip ci]"
|
||||
```
|
||||
|
||||
### Q: 构建失败如何调试?
|
||||
|
||||
1. 查看 Actions 日志详细错误信息
|
||||
2. 在本地测试 Docker 构建:
|
||||
```bash
|
||||
docker build -t test .
|
||||
```
|
||||
|
||||
## 📚 相关文档
|
||||
|
||||
- [自动版本发布指南](.github/AUTO_RELEASE_GUIDE.md)
|
||||
- [Docker Hub 配置指南](.github/DOCKER_HUB_SETUP.md)
|
||||
- [GitHub Actions 文档](https://docs.github.com/en/actions)
|
||||
- [Docker 官方文档](https://docs.docker.com/)
|
||||
@@ -0,0 +1,68 @@
|
||||
# git-cliff configuration file
|
||||
# https://git-cliff.org/docs/configuration
|
||||
|
||||
[changelog]
|
||||
# changelog header
|
||||
header = """
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
"""
|
||||
# template for the changelog body
|
||||
body = """
|
||||
{% if version %}\
|
||||
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
||||
{% else %}\
|
||||
## [unreleased]
|
||||
{% endif %}\
|
||||
{% for group, commits in commits | group_by(attribute="group") %}
|
||||
### {{ group | upper_first }}
|
||||
{% for commit in commits %}
|
||||
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/Wei-Shaw/claude-relay-service/commit/{{ commit.id }}))
|
||||
{%- endfor %}
|
||||
{% endfor %}\n
|
||||
"""
|
||||
# remove the leading and trailing whitespace from the template
|
||||
trim = true
|
||||
# changelog footer
|
||||
footer = """
|
||||
"""
|
||||
|
||||
[git]
|
||||
# parse the commits based on https://www.conventionalcommits.org
|
||||
conventional_commits = true
|
||||
# filter out the commits that are not conventional
|
||||
filter_unconventional = true
|
||||
# process each line of a commit as an individual commit
|
||||
split_commits = false
|
||||
# regex for preprocessing the commit messages
|
||||
commit_preprocessors = [
|
||||
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/Wei-Shaw/claude-relay-service/issues/${2}))" },
|
||||
]
|
||||
# regex for parsing and grouping commits
|
||||
commit_parsers = [
|
||||
{ message = "^feat", group = "Features" },
|
||||
{ message = "^fix", group = "Bug Fixes" },
|
||||
{ message = "^docs", group = "Documentation" },
|
||||
{ message = "^perf", group = "Performance" },
|
||||
{ message = "^refactor", group = "Refactor" },
|
||||
{ message = "^style", group = "Styling" },
|
||||
{ message = "^test", group = "Testing" },
|
||||
{ message = "^chore\\(release\\): prepare for", skip = true },
|
||||
{ message = "^chore", group = "Miscellaneous Tasks" },
|
||||
{ body = ".*security", group = "Security" },
|
||||
]
|
||||
# protect breaking changes from being skipped due to matching a skipping commit_parser
|
||||
protect_breaking_commits = false
|
||||
# filter out the commits that are not matched by commit parsers
|
||||
filter_commits = false
|
||||
# glob pattern for matching git tags
|
||||
tag_pattern = "v[0-9]*"
|
||||
# regex for skipping tags
|
||||
skip_tags = "v0.1.0-beta.1"
|
||||
# regex for ignoring tags
|
||||
ignore_tags = ""
|
||||
# sort the tags topologically
|
||||
topo_order = false
|
||||
# sort the commits inside sections by oldest/newest order
|
||||
sort_commits = "oldest"
|
||||
@@ -0,0 +1,6 @@
|
||||
# GitHub Secret Scanning Configuration
|
||||
# This file excludes specific paths from secret scanning
|
||||
|
||||
paths-ignore:
|
||||
- 'src/services/geminiAccountService.js'
|
||||
- 'data/demo/Gemini-CLI-2-API/gemini-core.js'
|
||||
@@ -0,0 +1,509 @@
|
||||
name: Auto Release Pipeline
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
workflow_dispatch: # 支持手动触发
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
packages: write
|
||||
|
||||
jobs:
|
||||
release-pipeline:
|
||||
runs-on: ubuntu-latest
|
||||
# 跳过由GitHub Actions创建的提交,避免死循环
|
||||
if: github.event.pusher.name != 'github-actions[bot]' && !contains(github.event.head_commit.message, '[skip ci]')
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Check if version bump is needed
|
||||
id: check
|
||||
run: |
|
||||
# 检查提交消息是否包含强制发布标记([force release])
|
||||
COMMIT_MSG=$(git log -1 --pretty=%B | tr -d '\r')
|
||||
echo "Latest commit message:"
|
||||
echo "$COMMIT_MSG"
|
||||
|
||||
FORCE_RELEASE=false
|
||||
if echo "$COMMIT_MSG" | grep -qi "\[force release\]"; then
|
||||
echo "Detected [force release] marker, forcing version bump"
|
||||
FORCE_RELEASE=true
|
||||
fi
|
||||
|
||||
# 检测是否是合并提交
|
||||
PARENT_COUNT=$(git rev-list --parents -n 1 HEAD | wc -w)
|
||||
PARENT_COUNT=$((PARENT_COUNT - 1))
|
||||
echo "Parent count: $PARENT_COUNT"
|
||||
|
||||
if [ "$PARENT_COUNT" -gt 1 ]; then
|
||||
# 合并提交:获取合并进来的所有文件变更
|
||||
echo "Detected merge commit, getting all merged changes"
|
||||
# 获取合并基准点
|
||||
MERGE_BASE=$(git merge-base HEAD^1 HEAD^2 2>/dev/null || echo "")
|
||||
if [ -n "$MERGE_BASE" ]; then
|
||||
# 获取从合并基准到 HEAD 的所有变更
|
||||
CHANGED_FILES=$(git diff --name-only $MERGE_BASE..HEAD)
|
||||
else
|
||||
# 如果无法获取合并基准,使用第二个父提交
|
||||
CHANGED_FILES=$(git diff --name-only HEAD^2..HEAD)
|
||||
fi
|
||||
else
|
||||
# 普通提交:获取相对于上一个提交的变更
|
||||
CHANGED_FILES=$(git diff --name-only HEAD~1..HEAD 2>/dev/null || git diff --name-only $(git rev-list --max-parents=0 HEAD)..HEAD)
|
||||
fi
|
||||
|
||||
echo "Changed files:"
|
||||
echo "$CHANGED_FILES"
|
||||
|
||||
# 检查是否只有无关文件(.md, docs/, .github/等)
|
||||
SIGNIFICANT_CHANGES=false
|
||||
while IFS= read -r file; do
|
||||
# 跳过空行
|
||||
[ -z "$file" ] && continue
|
||||
|
||||
# 检查是否是需要忽略的文件
|
||||
if [[ ! "$file" =~ \.(md|txt)$ ]] &&
|
||||
[[ ! "$file" =~ ^docs/ ]] &&
|
||||
[[ ! "$file" =~ ^\.github/ ]] &&
|
||||
[[ "$file" != "VERSION" ]] &&
|
||||
[[ "$file" != ".gitignore" ]] &&
|
||||
[[ "$file" != "LICENSE" ]]; then
|
||||
echo "Found significant change in: $file"
|
||||
SIGNIFICANT_CHANGES=true
|
||||
break
|
||||
fi
|
||||
done <<< "$CHANGED_FILES"
|
||||
|
||||
# 检查是否是手动触发
|
||||
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||
echo "Manual workflow trigger detected, forcing version bump"
|
||||
echo "needs_bump=true" >> $GITHUB_OUTPUT
|
||||
elif [ "$FORCE_RELEASE" = true ]; then
|
||||
echo "Force release marker detected, forcing version bump"
|
||||
echo "needs_bump=true" >> $GITHUB_OUTPUT
|
||||
elif [ "$SIGNIFICANT_CHANGES" = true ]; then
|
||||
echo "Significant changes detected, version bump needed"
|
||||
echo "needs_bump=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "No significant changes, skipping version bump"
|
||||
echo "needs_bump=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Get current version
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
id: get_version
|
||||
run: |
|
||||
# 获取最新的tag版本
|
||||
LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
|
||||
echo "Latest tag: $LATEST_TAG"
|
||||
TAG_VERSION=${LATEST_TAG#v}
|
||||
|
||||
# 获取VERSION文件中的版本
|
||||
FILE_VERSION=$(cat VERSION | tr -d '[:space:]')
|
||||
echo "VERSION file: $FILE_VERSION"
|
||||
|
||||
# 比较tag版本和文件版本,取较大值
|
||||
function version_gt() { test "$(printf '%s\n' "$@" | sort -V | head -n 1)" != "$1"; }
|
||||
|
||||
if version_gt "$FILE_VERSION" "$TAG_VERSION"; then
|
||||
VERSION="$FILE_VERSION"
|
||||
echo "Using VERSION file: $VERSION (newer than tag)"
|
||||
else
|
||||
VERSION="$TAG_VERSION"
|
||||
echo "Using tag version: $VERSION (newer or equal to file)"
|
||||
fi
|
||||
|
||||
echo "Current version: $VERSION"
|
||||
echo "current_version=$VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Calculate next version
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
id: next_version
|
||||
run: |
|
||||
VERSION="${{ steps.get_version.outputs.current_version }}"
|
||||
|
||||
# 分割版本号
|
||||
IFS='.' read -r -a version_parts <<< "$VERSION"
|
||||
MAJOR="${version_parts[0]:-0}"
|
||||
MINOR="${version_parts[1]:-0}"
|
||||
PATCH="${version_parts[2]:-0}"
|
||||
|
||||
# 默认递增patch版本
|
||||
NEW_PATCH=$((PATCH + 1))
|
||||
NEW_VERSION="${MAJOR}.${MINOR}.${NEW_PATCH}"
|
||||
|
||||
echo "New version: $NEW_VERSION"
|
||||
echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
|
||||
echo "new_tag=v$NEW_VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Update VERSION file
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
run: |
|
||||
echo "${{ steps.next_version.outputs.new_version }}" > VERSION
|
||||
|
||||
# 配置git
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
# 提交VERSION文件 - 添加 [skip ci] 以避免再次触发
|
||||
git add VERSION
|
||||
git commit -m "chore: sync VERSION file with release ${{ steps.next_version.outputs.new_tag }} [skip ci]"
|
||||
|
||||
# 构建前端并推送到 web-dist 分支
|
||||
- name: Setup Node.js
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '18'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: web/admin-spa/package-lock.json
|
||||
|
||||
- name: Build Frontend
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
run: |
|
||||
echo "Building frontend for version ${{ steps.next_version.outputs.new_version }}..."
|
||||
cd web/admin-spa
|
||||
npm ci
|
||||
npm run build
|
||||
echo "Frontend build completed"
|
||||
|
||||
- name: Push Frontend Build to web-dist Branch
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
run: |
|
||||
# 创建临时目录
|
||||
TEMP_DIR=$(mktemp -d)
|
||||
echo "Using temp directory: $TEMP_DIR"
|
||||
|
||||
# 复制构建产物到临时目录
|
||||
cp -r web/admin-spa/dist/* "$TEMP_DIR/"
|
||||
|
||||
# 检查 web-dist 分支是否存在
|
||||
if git ls-remote --heads origin web-dist | grep -q web-dist; then
|
||||
echo "Checking out existing web-dist branch"
|
||||
git fetch origin web-dist:web-dist
|
||||
git checkout web-dist
|
||||
else
|
||||
echo "Creating new web-dist branch"
|
||||
git checkout --orphan web-dist
|
||||
fi
|
||||
|
||||
# 清空当前目录(保留 .git)
|
||||
git rm -rf . 2>/dev/null || true
|
||||
|
||||
# 复制构建产物
|
||||
cp -r "$TEMP_DIR"/* .
|
||||
|
||||
# 添加 README
|
||||
cat > README.md << EOF
|
||||
# Claude Relay Service - Web Frontend Build
|
||||
|
||||
This branch contains the pre-built frontend assets for Claude Relay Service.
|
||||
|
||||
**DO NOT EDIT FILES IN THIS BRANCH DIRECTLY**
|
||||
|
||||
These files are automatically generated by the CI/CD pipeline.
|
||||
|
||||
Version: ${{ steps.next_version.outputs.new_version }}
|
||||
Build Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
|
||||
EOF
|
||||
|
||||
# 创建 .gitignore 文件以排除 node_modules
|
||||
cat > .gitignore << EOF
|
||||
node_modules/
|
||||
*.log
|
||||
.DS_Store
|
||||
.env
|
||||
EOF
|
||||
|
||||
# 只添加必要的文件,排除 node_modules
|
||||
git add --all -- ':!node_modules'
|
||||
git commit -m "chore: update frontend build for v${{ steps.next_version.outputs.new_version }} [skip ci]"
|
||||
git push origin web-dist --force
|
||||
|
||||
# 切换回主分支
|
||||
git checkout main
|
||||
|
||||
# 清理临时目录
|
||||
rm -rf "$TEMP_DIR"
|
||||
|
||||
echo "Frontend build pushed to web-dist branch successfully"
|
||||
|
||||
- name: Install git-cliff
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
run: |
|
||||
wget -q https://github.com/orhun/git-cliff/releases/download/v1.4.0/git-cliff-1.4.0-x86_64-unknown-linux-gnu.tar.gz
|
||||
tar -xzf git-cliff-1.4.0-x86_64-unknown-linux-gnu.tar.gz
|
||||
chmod +x git-cliff-1.4.0/git-cliff
|
||||
sudo mv git-cliff-1.4.0/git-cliff /usr/local/bin/
|
||||
|
||||
- name: Generate changelog
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
id: changelog
|
||||
run: |
|
||||
# 获取上一个tag以来的更新日志
|
||||
LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
|
||||
if [ -n "$LATEST_TAG" ]; then
|
||||
# 排除VERSION文件的提交
|
||||
CHANGELOG=$(git-cliff --config .github/cliff.toml $LATEST_TAG..HEAD --strip header | grep -v "bump version" | sed '/^$/d' || echo "- 代码优化和改进")
|
||||
else
|
||||
CHANGELOG=$(git-cliff --config .github/cliff.toml --strip header || echo "- 初始版本发布")
|
||||
fi
|
||||
echo "content<<EOF" >> $GITHUB_OUTPUT
|
||||
echo "$CHANGELOG" >> $GITHUB_OUTPUT
|
||||
echo "EOF" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Create and push tag
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
run: |
|
||||
NEW_TAG="${{ steps.next_version.outputs.new_tag }}"
|
||||
git tag -a "$NEW_TAG" -m "Release $NEW_TAG"
|
||||
git push origin HEAD:main "$NEW_TAG"
|
||||
|
||||
- name: Prepare image names
|
||||
id: image_names
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
run: |
|
||||
DOCKER_USERNAME="${{ secrets.DOCKERHUB_USERNAME }}"
|
||||
if [ -z "$DOCKER_USERNAME" ]; then
|
||||
DOCKER_USERNAME="weishaw"
|
||||
fi
|
||||
|
||||
DOCKER_IMAGE=$(echo "${DOCKER_USERNAME}/claude-relay-service" | tr '[:upper:]' '[:lower:]')
|
||||
GHCR_IMAGE=$(echo "ghcr.io/${{ github.repository_owner }}/claude-relay-service" | tr '[:upper:]' '[:lower:]')
|
||||
|
||||
{
|
||||
echo "docker_image=${DOCKER_IMAGE}"
|
||||
echo "ghcr_image=${GHCR_IMAGE}"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Create GitHub Release
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
tag_name: ${{ steps.next_version.outputs.new_tag }}
|
||||
name: Release ${{ steps.next_version.outputs.new_version }}
|
||||
body: |
|
||||
## 🐳 Docker 镜像
|
||||
|
||||
```bash
|
||||
docker pull ${{ steps.image_names.outputs.docker_image }}:${{ steps.next_version.outputs.new_tag }}
|
||||
docker pull ${{ steps.image_names.outputs.docker_image }}:latest
|
||||
docker pull ${{ steps.image_names.outputs.ghcr_image }}:${{ steps.next_version.outputs.new_tag }}
|
||||
docker pull ${{ steps.image_names.outputs.ghcr_image }}:latest
|
||||
```
|
||||
|
||||
## 📦 主要更新
|
||||
|
||||
${{ steps.changelog.outputs.content }}
|
||||
|
||||
## 📋 完整更新日志
|
||||
|
||||
查看 [所有版本](https://github.com/${{ github.repository }}/releases)
|
||||
draft: false
|
||||
prerelease: false
|
||||
generate_release_notes: true
|
||||
|
||||
# 自动清理旧的tags和releases(保持最近50个)
|
||||
- name: Cleanup old tags and releases
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
continue-on-error: true
|
||||
env:
|
||||
TAGS_TO_KEEP: 50
|
||||
run: |
|
||||
echo "🧹 自动清理旧版本,保持最近 $TAGS_TO_KEEP 个tag..."
|
||||
|
||||
# 获取所有版本tag并按版本号排序(从旧到新)
|
||||
echo "正在获取所有tags..."
|
||||
ALL_TAGS=$(git ls-remote --tags origin | grep -E 'refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$' | awk '{print $2}' | sed 's|refs/tags/||' | sort -V)
|
||||
|
||||
# 检查是否获取到tags
|
||||
if [ -z "$ALL_TAGS" ]; then
|
||||
echo "⚠️ 未找到任何版本tag"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
TOTAL_COUNT=$(echo "$ALL_TAGS" | wc -l)
|
||||
|
||||
echo "📊 当前tag统计:"
|
||||
echo "- 总数: $TOTAL_COUNT"
|
||||
echo "- 配置保留: $TAGS_TO_KEEP"
|
||||
|
||||
if [ "$TOTAL_COUNT" -gt "$TAGS_TO_KEEP" ]; then
|
||||
DELETE_COUNT=$((TOTAL_COUNT - TAGS_TO_KEEP))
|
||||
echo "- 将要删除: $DELETE_COUNT 个最旧的tag"
|
||||
|
||||
# 获取要删除的tags(最老的)
|
||||
TAGS_TO_DELETE=$(echo "$ALL_TAGS" | head -n "$DELETE_COUNT")
|
||||
|
||||
# 显示将要删除的版本范围
|
||||
OLDEST_TO_DELETE=$(echo "$TAGS_TO_DELETE" | head -1)
|
||||
NEWEST_TO_DELETE=$(echo "$TAGS_TO_DELETE" | tail -1)
|
||||
echo ""
|
||||
echo "🗑️ 将要删除的版本范围:"
|
||||
echo "- 从: $OLDEST_TO_DELETE"
|
||||
echo "- 到: $NEWEST_TO_DELETE"
|
||||
|
||||
echo ""
|
||||
echo "开始执行删除..."
|
||||
SUCCESS_COUNT=0
|
||||
FAIL_COUNT=0
|
||||
|
||||
for tag in $TAGS_TO_DELETE; do
|
||||
echo -n " 删除 $tag ... "
|
||||
|
||||
# 先检查release是否存在
|
||||
if gh release view "$tag" >/dev/null 2>&1; then
|
||||
# Release存在,删除release会同时删除tag
|
||||
if gh release delete "$tag" --yes --cleanup-tag 2>/dev/null; then
|
||||
echo "✅ (release+tag)"
|
||||
SUCCESS_COUNT=$((SUCCESS_COUNT + 1))
|
||||
else
|
||||
echo "❌ (release删除失败)"
|
||||
FAIL_COUNT=$((FAIL_COUNT + 1))
|
||||
fi
|
||||
else
|
||||
# Release不存在,只删除tag
|
||||
if git push origin --delete "$tag" 2>/dev/null; then
|
||||
echo "✅ (仅tag)"
|
||||
SUCCESS_COUNT=$((SUCCESS_COUNT + 1))
|
||||
else
|
||||
echo "⏭️ (已不存在)"
|
||||
FAIL_COUNT=$((FAIL_COUNT + 1))
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
echo ""
|
||||
echo "📊 清理结果:"
|
||||
echo "- 成功删除: $SUCCESS_COUNT"
|
||||
echo "- 失败/跳过: $FAIL_COUNT"
|
||||
|
||||
# 重新获取并显示保留的版本范围
|
||||
echo ""
|
||||
echo "正在验证清理结果..."
|
||||
REMAINING_TAGS=$(git ls-remote --tags origin | grep -E 'refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$' | awk '{print $2}' | sed 's|refs/tags/||' | sort -V)
|
||||
REMAINING_COUNT=$(echo "$REMAINING_TAGS" | wc -l)
|
||||
OLDEST=$(echo "$REMAINING_TAGS" | head -1)
|
||||
NEWEST=$(echo "$REMAINING_TAGS" | tail -1)
|
||||
|
||||
echo "✅ 清理完成!"
|
||||
echo ""
|
||||
echo "📌 当前保留的版本:"
|
||||
echo "- 最旧版本: $OLDEST"
|
||||
echo "- 最新版本: $NEWEST"
|
||||
echo "- 版本总数: $REMAINING_COUNT"
|
||||
|
||||
# 验证是否达到预期
|
||||
if [ "$REMAINING_COUNT" -le "$TAGS_TO_KEEP" ]; then
|
||||
echo "- 状态: ✅ 符合预期(≤$TAGS_TO_KEEP)"
|
||||
else
|
||||
echo "- 状态: ⚠️ 超出预期(某些tag可能删除失败)"
|
||||
fi
|
||||
else
|
||||
echo "✅ 当前tag数量($TOTAL_COUNT)未超过限制($TAGS_TO_KEEP),无需清理"
|
||||
fi
|
||||
|
||||
# Docker构建步骤
|
||||
- name: Set up QEMU
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to Docker Hub
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: docker.io
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
- name: Log in to GitHub Container Registry
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.repository_owner }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build and push Docker image
|
||||
if: steps.check.outputs.needs_bump == 'true'
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: |
|
||||
${{ steps.image_names.outputs.docker_image }}:${{ steps.next_version.outputs.new_tag }}
|
||||
${{ steps.image_names.outputs.docker_image }}:latest
|
||||
${{ steps.image_names.outputs.docker_image }}:${{ steps.next_version.outputs.new_version }}
|
||||
${{ steps.image_names.outputs.ghcr_image }}:${{ steps.next_version.outputs.new_tag }}
|
||||
${{ steps.image_names.outputs.ghcr_image }}:latest
|
||||
${{ steps.image_names.outputs.ghcr_image }}:${{ steps.next_version.outputs.new_version }}
|
||||
labels: |
|
||||
org.opencontainers.image.version=${{ steps.next_version.outputs.new_version }}
|
||||
org.opencontainers.image.revision=${{ github.sha }}
|
||||
org.opencontainers.image.source=https://github.com/${{ github.repository }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
|
||||
- name: Send Telegram Notification
|
||||
if: steps.check.outputs.needs_bump == 'true' && env.TELEGRAM_BOT_TOKEN != '' && env.TELEGRAM_CHAT_ID != ''
|
||||
env:
|
||||
TELEGRAM_BOT_TOKEN: ${{ secrets.TELEGRAM_BOT_TOKEN }}
|
||||
TELEGRAM_CHAT_ID: ${{ secrets.TELEGRAM_CHAT_ID }}
|
||||
DOCKER_IMAGE: ${{ steps.image_names.outputs.docker_image }}
|
||||
GHCR_IMAGE: ${{ steps.image_names.outputs.ghcr_image }}
|
||||
continue-on-error: true
|
||||
run: |
|
||||
VERSION="${{ steps.next_version.outputs.new_version }}"
|
||||
TAG="${{ steps.next_version.outputs.new_tag }}"
|
||||
REPO="${{ github.repository }}"
|
||||
|
||||
# 获取更新内容并限制长度
|
||||
CHANGELOG="${{ steps.changelog.outputs.content }}"
|
||||
CHANGELOG_TRUNCATED=$(echo "$CHANGELOG" | head -c 1000)
|
||||
if [ ${#CHANGELOG} -gt 1000 ]; then
|
||||
CHANGELOG_TRUNCATED="${CHANGELOG_TRUNCATED}..."
|
||||
fi
|
||||
|
||||
# 构建消息内容
|
||||
MESSAGE="🚀 *Claude Relay Service 新版本发布!*"$'\n'$'\n'
|
||||
MESSAGE+="📦 版本号: \`${VERSION}\`"$'\n'$'\n'
|
||||
MESSAGE+="📝 *更新内容:*"$'\n'
|
||||
MESSAGE+="${CHANGELOG_TRUNCATED}"$'\n'$'\n'
|
||||
MESSAGE+="🐳 *Docker 部署:*"$'\n'
|
||||
MESSAGE+="\`\`\`bash"$'\n'
|
||||
MESSAGE+="docker pull ${DOCKER_IMAGE}:${TAG}"$'\n'
|
||||
MESSAGE+="docker pull ${DOCKER_IMAGE}:latest"$'\n'
|
||||
MESSAGE+="docker pull ${GHCR_IMAGE}:${TAG}"$'\n'
|
||||
MESSAGE+="docker pull ${GHCR_IMAGE}:latest"$'\n'
|
||||
MESSAGE+="\`\`\`"$'\n'$'\n'
|
||||
MESSAGE+="🔗 *相关链接:*"$'\n'
|
||||
MESSAGE+="• [GitHub Release](https://github.com/${REPO}/releases/tag/${TAG})"$'\n'
|
||||
MESSAGE+="• [完整更新日志](https://github.com/${REPO}/releases)"$'\n'
|
||||
MESSAGE+="• [Docker Hub](https://hub.docker.com/r/${DOCKER_IMAGE%/*}/claude-relay-service)"$'\n'
|
||||
MESSAGE+="• [GHCR](https://ghcr.io/${GHCR_IMAGE#ghcr.io/})"$'\n'$'\n'
|
||||
MESSAGE+="#ClaudeRelay #Update #v${VERSION//./_}"
|
||||
|
||||
# 使用 jq 构建 JSON 并发送
|
||||
jq -n \
|
||||
--arg chat_id "${TELEGRAM_CHAT_ID}" \
|
||||
--arg text "${MESSAGE}" \
|
||||
'{
|
||||
chat_id: $chat_id,
|
||||
text: $text,
|
||||
parse_mode: "Markdown",
|
||||
disable_web_page_preview: false
|
||||
}' | \
|
||||
curl -X POST "https://api.telegram.org/bot${TELEGRAM_BOT_TOKEN}/sendMessage" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d @-
|
||||
@@ -0,0 +1,320 @@
|
||||
name: PR Lint and Format Check
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
paths:
|
||||
- '**.js'
|
||||
- '**.jsx'
|
||||
- '**.ts'
|
||||
- '**.tsx'
|
||||
- '**.vue'
|
||||
- '**.json'
|
||||
- '**.cjs'
|
||||
- '**.mjs'
|
||||
- '.prettierrc'
|
||||
- '.eslintrc.cjs'
|
||||
- 'package.json'
|
||||
- 'web/admin-spa/**'
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
lint-and-format:
|
||||
runs-on: ubuntu-latest
|
||||
name: Check Code Quality
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '18'
|
||||
cache: 'npm'
|
||||
|
||||
- name: Cache dependencies
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
npm ci --prefer-offline --no-audit
|
||||
# 安装 web 目录的依赖(如果存在)
|
||||
if [ -d "web/admin-spa" ] && [ -f "web/admin-spa/package.json" ]; then
|
||||
cd web/admin-spa
|
||||
npm ci --prefer-offline --no-audit
|
||||
cd ../..
|
||||
fi
|
||||
|
||||
- name: Get changed files
|
||||
id: changed-files
|
||||
uses: tj-actions/changed-files@v41
|
||||
with:
|
||||
files: |
|
||||
**/*.js
|
||||
**/*.jsx
|
||||
**/*.ts
|
||||
**/*.tsx
|
||||
**/*.vue
|
||||
**/*.cjs
|
||||
**/*.mjs
|
||||
**/*.json
|
||||
files_ignore: |
|
||||
node_modules/**
|
||||
dist/**
|
||||
build/**
|
||||
coverage/**
|
||||
.git/**
|
||||
logs/**
|
||||
temp/**
|
||||
tmp/**
|
||||
|
||||
- name: Check Prettier formatting
|
||||
if: steps.changed-files.outputs.any_changed == 'true'
|
||||
id: prettier-check
|
||||
run: |
|
||||
echo "🔍 Checking Prettier formatting for changed files..."
|
||||
echo "Changed files: ${{ steps.changed-files.outputs.all_changed_files }}"
|
||||
|
||||
# 初始化标志
|
||||
PRETTIER_FAILED=false
|
||||
PRETTIER_OUTPUT=""
|
||||
|
||||
# 检查每个改变的文件
|
||||
for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
|
||||
if [ -f "$file" ]; then
|
||||
echo "Checking: $file"
|
||||
|
||||
# 根据文件位置选择正确的 prettier 配置
|
||||
if [[ "$file" == web/admin-spa/* ]]; then
|
||||
# 前端文件:进入前端目录运行 prettier
|
||||
cd web/admin-spa
|
||||
RELATIVE_FILE="${file#web/admin-spa/}"
|
||||
if ! npx prettier --check "$RELATIVE_FILE" 2>&1; then
|
||||
PRETTIER_FAILED=true
|
||||
DIFF=$(npx prettier "$RELATIVE_FILE" | diff -u "$RELATIVE_FILE" - || true)
|
||||
if [ -n "$DIFF" ]; then
|
||||
PRETTIER_OUTPUT="${PRETTIER_OUTPUT}❌ File needs formatting: $file\n"
|
||||
PRETTIER_OUTPUT="${PRETTIER_OUTPUT}\`\`\`diff\n${DIFF}\n\`\`\`\n\n"
|
||||
fi
|
||||
else
|
||||
echo "✅ $file is properly formatted"
|
||||
fi
|
||||
cd ../..
|
||||
else
|
||||
# 后端文件:使用根目录的 prettier
|
||||
if ! npx prettier --check "$file" 2>&1; then
|
||||
PRETTIER_FAILED=true
|
||||
DIFF=$(npx prettier "$file" | diff -u "$file" - || true)
|
||||
if [ -n "$DIFF" ]; then
|
||||
PRETTIER_OUTPUT="${PRETTIER_OUTPUT}❌ File needs formatting: $file\n"
|
||||
PRETTIER_OUTPUT="${PRETTIER_OUTPUT}\`\`\`diff\n${DIFF}\n\`\`\`\n\n"
|
||||
fi
|
||||
else
|
||||
echo "✅ $file is properly formatted"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
# 输出结果
|
||||
if [ "$PRETTIER_FAILED" = true ]; then
|
||||
echo "prettier_failed=true" >> $GITHUB_OUTPUT
|
||||
echo -e "$PRETTIER_OUTPUT" > prettier-report.md
|
||||
echo "❌ Some files are not properly formatted."
|
||||
echo "Please run: npm run format (backend) or cd web/admin-spa && npm run format (frontend)"
|
||||
exit 1
|
||||
else
|
||||
echo "prettier_failed=false" >> $GITHUB_OUTPUT
|
||||
echo "✅ All files are properly formatted"
|
||||
fi
|
||||
|
||||
- name: Run ESLint
|
||||
if: steps.changed-files.outputs.any_changed == 'true'
|
||||
id: eslint-check
|
||||
run: |
|
||||
echo "🔍 Running ESLint on changed files..."
|
||||
|
||||
# 分离前端和后端文件
|
||||
BACKEND_FILES=""
|
||||
FRONTEND_FILES=""
|
||||
|
||||
for file in ${{ steps.changed-files.outputs.all_changed_files }}; do
|
||||
if [[ "$file" =~ \.(js|jsx|vue|cjs|mjs)$ ]] && [ -f "$file" ]; then
|
||||
if [[ "$file" == web/admin-spa/* ]]; then
|
||||
FRONTEND_FILES="$FRONTEND_FILES ${file#web/admin-spa/}"
|
||||
else
|
||||
BACKEND_FILES="$BACKEND_FILES $file"
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
ESLINT_FAILED=false
|
||||
ESLINT_OUTPUT=""
|
||||
|
||||
# 检查后端文件
|
||||
if [ -n "$BACKEND_FILES" ]; then
|
||||
echo "Linting backend files: $BACKEND_FILES"
|
||||
set +e
|
||||
BACKEND_OUTPUT=$(npx eslint $BACKEND_FILES --format stylish 2>&1)
|
||||
BACKEND_EXIT_CODE=$?
|
||||
set -e
|
||||
|
||||
if [ $BACKEND_EXIT_CODE -ne 0 ]; then
|
||||
ESLINT_FAILED=true
|
||||
ESLINT_OUTPUT="${ESLINT_OUTPUT}### Backend ESLint Issues\n\`\`\`\n${BACKEND_OUTPUT}\n\`\`\`\n\n"
|
||||
fi
|
||||
fi
|
||||
|
||||
# 检查前端文件
|
||||
if [ -n "$FRONTEND_FILES" ]; then
|
||||
echo "Linting frontend files: $FRONTEND_FILES"
|
||||
cd web/admin-spa
|
||||
set +e
|
||||
FRONTEND_OUTPUT=$(npx eslint $FRONTEND_FILES --format stylish 2>&1)
|
||||
FRONTEND_EXIT_CODE=$?
|
||||
set -e
|
||||
cd ../..
|
||||
|
||||
if [ $FRONTEND_EXIT_CODE -ne 0 ]; then
|
||||
ESLINT_FAILED=true
|
||||
ESLINT_OUTPUT="${ESLINT_OUTPUT}### Frontend ESLint Issues\n\`\`\`\n${FRONTEND_OUTPUT}\n\`\`\`\n\n"
|
||||
fi
|
||||
fi
|
||||
|
||||
# 输出结果
|
||||
if [ "$ESLINT_FAILED" = true ]; then
|
||||
echo "eslint_failed=true" >> $GITHUB_OUTPUT
|
||||
echo "❌ ESLint found issues"
|
||||
|
||||
# 创建错误报告
|
||||
echo "## ESLint Report" > eslint-report.md
|
||||
echo "$ESLINT_OUTPUT" >> eslint-report.md
|
||||
echo "" >> eslint-report.md
|
||||
echo "Please fix these issues by running:" >> eslint-report.md
|
||||
echo '```bash' >> eslint-report.md
|
||||
echo "# Backend: npm run lint" >> eslint-report.md
|
||||
echo "# Frontend: cd web/admin-spa && npm run lint" >> eslint-report.md
|
||||
echo '```' >> eslint-report.md
|
||||
|
||||
exit 1
|
||||
else
|
||||
echo "eslint_failed=false" >> $GITHUB_OUTPUT
|
||||
echo "✅ ESLint check passed"
|
||||
fi
|
||||
|
||||
- name: Debug PR Context
|
||||
if: failure()
|
||||
run: |
|
||||
echo "PR Number: ${{ github.event.pull_request.number }}"
|
||||
echo "Repo: ${{ github.repository }}"
|
||||
echo "Event Name: ${{ github.event_name }}"
|
||||
echo "Actor: ${{ github.actor }}"
|
||||
|
||||
- name: Comment PR with results
|
||||
if: failure()
|
||||
continue-on-error: true # 即使评论失败也继续
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
github-token: ${{ secrets.GH_PAT || secrets.GITHUB_TOKEN }}
|
||||
script: |
|
||||
const fs = require('fs');
|
||||
let comment = '## 🚨 Code Quality Check Failed\n\n';
|
||||
|
||||
// 读取 Prettier 报告
|
||||
if (fs.existsSync('prettier-report.md')) {
|
||||
const prettierReport = fs.readFileSync('prettier-report.md', 'utf8');
|
||||
comment += '### Prettier Formatting Issues\n\n';
|
||||
comment += prettierReport;
|
||||
comment += '\n**Fix command:**\n```bash\nnpm run format\n```\n\n';
|
||||
}
|
||||
|
||||
// 读取 ESLint 报告
|
||||
if (fs.existsSync('eslint-report.md')) {
|
||||
const eslintReport = fs.readFileSync('eslint-report.md', 'utf8');
|
||||
comment += '### ESLint Issues\n\n';
|
||||
comment += eslintReport;
|
||||
}
|
||||
|
||||
comment += '\n---\n';
|
||||
comment += '💡 **提示**: 在本地运行以下命令来自动修复大部分问题:\n';
|
||||
comment += '```bash\n';
|
||||
comment += '# 后端代码\n';
|
||||
comment += 'npm run format # 修复后端 Prettier 格式问题\n';
|
||||
comment += 'npm run lint # 修复后端 ESLint 问题\n';
|
||||
comment += '\n';
|
||||
comment += '# 前端代码\n';
|
||||
comment += 'cd web/admin-spa\n';
|
||||
comment += 'npm run format # 修复前端 Prettier 格式问题\n';
|
||||
comment += 'npm run lint # 修复前端 ESLint 问题\n';
|
||||
comment += '```\n';
|
||||
|
||||
// 查找是否已有机器人评论
|
||||
const { data: comments } = await github.rest.issues.listComments({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
});
|
||||
|
||||
const botComment = comments.find(comment =>
|
||||
comment.user.type === 'Bot' &&
|
||||
comment.body.includes('Code Quality Check Failed')
|
||||
);
|
||||
|
||||
if (botComment) {
|
||||
// 更新现有评论
|
||||
await github.rest.issues.updateComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
comment_id: botComment.id,
|
||||
body: comment
|
||||
});
|
||||
} else {
|
||||
// 创建新评论
|
||||
await github.rest.issues.createComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
body: comment
|
||||
});
|
||||
}
|
||||
|
||||
- name: Success comment
|
||||
if: success() && steps.changed-files.outputs.any_changed == 'true'
|
||||
continue-on-error: true # 即使评论失败也继续
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
github-token: ${{ secrets.GH_PAT || secrets.GITHUB_TOKEN }}
|
||||
script: |
|
||||
// 查找是否已有失败的评论
|
||||
const { data: comments } = await github.rest.issues.listComments({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
issue_number: context.issue.number,
|
||||
});
|
||||
|
||||
const botComment = comments.find(comment =>
|
||||
comment.user.type === 'Bot' &&
|
||||
comment.body.includes('Code Quality Check Failed')
|
||||
);
|
||||
|
||||
if (botComment) {
|
||||
// 如果之前有失败评论,更新为成功
|
||||
await github.rest.issues.updateComment({
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
comment_id: botComment.id,
|
||||
body: '## ✅ Code Quality Check Passed\n\nAll files are properly formatted and pass linting checks!'
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,62 @@
|
||||
name: 同步模型价格数据
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '*/10 * * * *'
|
||||
workflow_dispatch: {}
|
||||
|
||||
jobs:
|
||||
sync-pricing:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: 检出 price-mirror 分支
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: price-mirror
|
||||
fetch-depth: 0
|
||||
|
||||
- name: 下载上游价格文件
|
||||
id: fetch
|
||||
run: |
|
||||
set -euo pipefail
|
||||
curl -fsSL https://github.com/Wei-Shaw/model-price-repo/raw/refs/heads/main/model_prices_and_context_window.json \
|
||||
-o model_prices_and_context_window.json.new
|
||||
|
||||
NEW_HASH=$(sha256sum model_prices_and_context_window.json.new | awk '{print $1}')
|
||||
|
||||
if [ -f model_prices_and_context_window.sha256 ]; then
|
||||
OLD_HASH=$(cat model_prices_and_context_window.sha256 | tr -d ' \n\r')
|
||||
else
|
||||
OLD_HASH=""
|
||||
fi
|
||||
|
||||
if [ "$NEW_HASH" = "$OLD_HASH" ]; then
|
||||
echo "价格文件无变化,跳过提交"
|
||||
echo "changed=false" >> "$GITHUB_OUTPUT"
|
||||
rm -f model_prices_and_context_window.json.new
|
||||
exit 0
|
||||
fi
|
||||
|
||||
mv model_prices_and_context_window.json.new model_prices_and_context_window.json
|
||||
echo "$NEW_HASH" > model_prices_and_context_window.sha256
|
||||
|
||||
echo "changed=true" >> "$GITHUB_OUTPUT"
|
||||
echo "hash=$NEW_HASH" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: 提交并推送变更
|
||||
if: steps.fetch.outputs.changed == 'true'
|
||||
env:
|
||||
NEW_HASH: ${{ steps.fetch.outputs.hash }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git add model_prices_and_context_window.json model_prices_and_context_window.sha256
|
||||
COMMIT_MSG="chore: 同步模型价格数据"
|
||||
if [ -n "${NEW_HASH}" ]; then
|
||||
COMMIT_MSG="$COMMIT_MSG (${NEW_HASH})"
|
||||
fi
|
||||
git commit -m "$COMMIT_MSG"
|
||||
git push origin price-mirror
|
||||
Reference in New Issue
Block a user