mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-01-10 23:59:45 +08:00

feat(scripts): migrate feishu-notify to TypeScript CLI tool with subcommands (#12371 )

* build: add commander package as dependency

* refactor(scripts): migrate feishu-notify to TypeScript with CLI interface

- Convert JavaScript implementation to TypeScript with proper type definitions
- Add CLI interface using commander for better usability
- Improve error handling and input validation
- Add version management and subcommand support

* ci(workflows): update feishu notification command and add pnpm install step

Update the feishu notification command to use CLI tool with proper arguments instead of direct node script execution
Add pnpm install step to ensure dependencies are available before running the workflow

* docs: add feishu notification script documentation

Add Chinese and English documentation for the feishu-notify.ts CLI tool

* feat(notify): add generic send command to feishu-notify

Add a new 'send' subcommand to send simple notifications to Feishu with customizable title, description and header color. This provides a more flexible way to send notifications without being tied to specific business logic like the existing 'issue' command.

The implementation includes:
- New send command handler and options interface
- Simple card creation function
- Zod schema for header color validation
- Documentation updates in both Chinese and English

2026-01-08 16:55:46 +08:00

4.4 KiB

Raw Blame History

飞书通知脚本

scripts/feishu-notify.ts 是一个 CLI 工具，用于向飞书 Webhook 发送通知。该脚本主要在 GitHub Actions 工作流中使用，实现自动通知功能。

功能特性

基于子命令的 CLI 结构，支持不同类型的通知
使用 HMAC-SHA256 签名验证
发送飞书交互式卡片消息
完整的 TypeScript 类型支持
通过环境变量传递凭证，确保安全性

使用方式

前置依赖

pnpm install

CLI 结构

pnpm tsx scripts/feishu-notify.ts [command] [options]

环境变量（必需）

变量	说明
`FEISHU_WEBHOOK_URL`	飞书 Webhook URL
`FEISHU_WEBHOOK_SECRET`	飞书 Webhook 签名密钥

命令

`send` - 发送简单通知

发送通用通知，不涉及具体业务逻辑。

pnpm tsx scripts/feishu-notify.ts send [options]

参数	短选项	说明	必需
`--title`	`-t`	卡片标题	是
`--description`	`-d`	卡片描述（支持 markdown）	是
`--color`	`-c`	标题栏颜色模板	否（默认：turquoise）

可用颜色： blue（蓝色）, wathet（浅蓝）, turquoise（青绿）, green（绿色）, yellow（黄色）, orange（橙色）, red（红色）, carmine（深红）, violet（紫罗兰）, purple（紫色）, indigo（靛蓝）, grey（灰色）, default（默认）

示例

# 使用 $'...' 语法实现正确的换行
pnpm tsx scripts/feishu-notify.ts send \
  -t "部署完成" \
  -d $'**状态:** 成功\n\n**环境:** 生产环境\n\n**版本:** v1.2.3' \
  -c green

# 发送错误警报（红色）
pnpm tsx scripts/feishu-notify.ts send \
  -t "错误警报" \
  -d $'**错误类型:** 连接失败\n\n**严重程度:** 高\n\n请及时检查系统状态' \
  -c red

注意： 如需在描述中换行，请使用 bash 的 $'...' 语法。不要在双引号中使用字面量 \n，否则会原样显示在飞书卡片中。

`issue` - 发送 GitHub Issue 通知

pnpm tsx scripts/feishu-notify.ts issue [options]

参数	短选项	说明	必需
`--url`	`-u`	GitHub Issue URL	是
`--number`	`-n`	Issue 编号	是
`--title`	`-t`	Issue 标题	是
`--summary`	`-m`	Issue 摘要	是
`--author`	`-a`	Issue 作者	否（默认："Unknown"）
`--labels`	`-l`	Issue 标签（逗号分隔）	否

示例

pnpm tsx scripts/feishu-notify.ts issue \
  -u "https://github.com/owner/repo/issues/123" \
  -n "123" \
  -t "Bug: Something is broken" \
  -m "这是一个关于某功能的 bug 报告" \
  -a "username" \
  -l "bug,high-priority"

在 GitHub Actions 中使用

该脚本主要在 .github/workflows/github-issue-tracker.yml 工作流中使用：

- name: Install dependencies
  run: pnpm install

- name: Send notification
  run: |
    pnpm tsx scripts/feishu-notify.ts issue \
      -u "${{ github.event.issue.html_url }}" \
      -n "${{ github.event.issue.number }}" \
      -t "${{ github.event.issue.title }}" \
      -a "${{ github.event.issue.user.login }}" \
      -l "${{ join(github.event.issue.labels.*.name, ',') }}" \
      -m "Issue 摘要内容"    
  env:
    FEISHU_WEBHOOK_URL: ${{ secrets.FEISHU_WEBHOOK_URL }}
    FEISHU_WEBHOOK_SECRET: ${{ secrets.FEISHU_WEBHOOK_SECRET }}

飞书卡片消息格式

issue 命令发送的交互式卡片包含以下内容：

标题: #<issue编号> - <issue标题>
作者: Issue 创建者
标签: Issue 标签列表（如有）
摘要: Issue 内容摘要
操作按钮: "View Issue" 按钮，点击跳转到 GitHub Issue 页面

配置飞书 Webhook

在飞书群组中添加自定义机器人
获取 Webhook URL 和签名密钥
将 URL 和密钥配置到 GitHub Secrets：
- FEISHU_WEBHOOK_URL: Webhook 地址
- FEISHU_WEBHOOK_SECRET: 签名密钥

错误处理

脚本在以下情况会返回非零退出码：

缺少必需的环境变量（FEISHU_WEBHOOK_URL、FEISHU_WEBHOOK_SECRET）
缺少必需的命令参数
飞书 API 返回非 2xx 状态码
网络请求失败

扩展新命令

CLI 设计支持多种通知类型。添加新命令的步骤：

定义命令选项接口
创建卡片构建函数
添加新的命令处理函数
使用 program.command() 注册命令

4.4 KiB Raw Blame History Unescape Escape