mirror of
https://github.com/Wei-Shaw/claude-relay-service.git
synced 2026-01-22 16:43:35 +00:00
feat: 添加 Telegram 自动通知功能
- 在 auto-release.yml 中添加 Telegram 通知步骤 - 新版本发布时自动发送通知到 Telegram 频道 - 包含版本号、更新内容、Docker 命令等信息 - 添加 TELEGRAM_SETUP.md 详细配置指南 - 更新相关文档说明 通知功能是可选的,需要配置以下 GitHub Secrets: - TELEGRAM_BOT_TOKEN - TELEGRAM_CHAT_ID 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
17
.github/AUTO_RELEASE_GUIDE.md
vendored
17
.github/AUTO_RELEASE_GUIDE.md
vendored
@@ -73,6 +73,7 @@ git push origin v1.1.0
|
||||
- 生成 changelog
|
||||
- 创建 GitHub Release
|
||||
- 更新 CHANGELOG.md 文件
|
||||
- 发送 Telegram 通知(可选)
|
||||
|
||||
### Changelog 生成
|
||||
|
||||
@@ -140,8 +141,24 @@ 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)
|
||||
110
.github/TELEGRAM_SETUP.md
vendored
Normal file
110
.github/TELEGRAM_SETUP.md
vendored
Normal file
@@ -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 以保证安全
|
||||
55
.github/workflows/auto-release.yml
vendored
55
.github/workflows/auto-release.yml
vendored
@@ -140,4 +140,57 @@ jobs:
|
||||
git add CHANGELOG.md
|
||||
git commit -m "chore: update CHANGELOG.md for ${{ steps.next_version.outputs.new_tag }} [skip ci]"
|
||||
git push origin main
|
||||
fi
|
||||
fi
|
||||
|
||||
- name: Send Telegram Notification
|
||||
if: steps.check_changes.outputs.has_changes == 'true' && env.TELEGRAM_BOT_TOKEN != '' && env.TELEGRAM_CHAT_ID != ''
|
||||
env:
|
||||
TELEGRAM_BOT_TOKEN: ${{ secrets.TELEGRAM_BOT_TOKEN }}
|
||||
TELEGRAM_CHAT_ID: ${{ secrets.TELEGRAM_CHAT_ID }}
|
||||
continue-on-error: true
|
||||
run: |
|
||||
# 准备 Telegram 消息内容
|
||||
VERSION="${{ steps.next_version.outputs.new_version }}"
|
||||
TAG="${{ steps.next_version.outputs.new_tag }}"
|
||||
REPO="${{ github.repository }}"
|
||||
|
||||
# 获取更新内容(限制长度)
|
||||
CHANGELOG="${{ steps.changelog.outputs.content }}"
|
||||
# 截取前 1000 个字符避免消息过长
|
||||
CHANGELOG_TRUNCATED=$(echo "$CHANGELOG" | head -c 1000)
|
||||
if [ ${#CHANGELOG} -gt 1000 ]; then
|
||||
CHANGELOG_TRUNCATED="${CHANGELOG_TRUNCATED}..."
|
||||
fi
|
||||
|
||||
# 构建消息
|
||||
MESSAGE="🚀 *Claude Relay Service 新版本发布!*
|
||||
|
||||
📦 版本号: \`${VERSION}\`
|
||||
|
||||
📝 *更新内容:*
|
||||
${CHANGELOG_TRUNCATED}
|
||||
|
||||
🐳 *Docker 部署:*
|
||||
\`\`\`bash
|
||||
docker pull weishaw/claude-relay-service:${TAG}
|
||||
docker pull weishaw/claude-relay-service:latest
|
||||
\`\`\`
|
||||
|
||||
🔗 *相关链接:*
|
||||
• [GitHub Release](https://github.com/${REPO}/releases/tag/${TAG})
|
||||
• [完整更新日志](https://github.com/${REPO}/blob/main/CHANGELOG.md)
|
||||
• [Docker Hub](https://hub.docker.com/r/weishaw/claude-relay-service)
|
||||
|
||||
#ClaudeRelay #Update #v${VERSION//./_}"
|
||||
|
||||
# 发送消息到 Telegram
|
||||
curl -X POST "https://api.telegram.org/bot${TELEGRAM_BOT_TOKEN}/sendMessage" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d @- << EOF
|
||||
{
|
||||
"chat_id": "${TELEGRAM_CHAT_ID}",
|
||||
"text": "${MESSAGE}",
|
||||
"parse_mode": "Markdown",
|
||||
"disable_web_page_preview": false
|
||||
}
|
||||
EOF
|
||||
Reference in New Issue
Block a user