一个用于发送消息到飞书机器人的 GitHub Action。
- 支持发送 Markdown 消息
- 支持发送 GitHub 事件模板消息
- 支持飞书机器人签名验证
- 自动处理 GitHub 事件信息
- 飞书卡片消息
name: Send to Feishu
on:
push:
branches: [ main ]
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Send notification to Feishu
uses: XRSec/feishu-bot-webhook-action@v1
with:
FEISHU_BOT_WEBHOOK: ${{ secrets.FEISHU_BOT_WEBHOOK }}
FEISHU_BOT_SIGNKEY: ${{ secrets.FEISHU_BOT_SIGNKEY }}name: Send Custom Message
on:
workflow_dispatch:
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Send custom message to Feishu
uses: XRSec/feishu-bot-webhook-action@v1
with:
FEISHU_BOT_WEBHOOK: ${{ secrets.FEISHU_BOT_WEBHOOK }}
FEISHU_BOT_SIGNKEY: ${{ secrets.FEISHU_BOT_SIGNKEY }}
MSG_TEXT: |
## 部署完成！🎉
**状态**: 成功
**分支**: main
**链接**: [查看详情](https://github.com/user/repo)
用户可以直接在 Markdown 中编写链接，如 [GitHub](https://github.com)，无需额外处理。with:
FEISHU_BOT_WEBHOOK: ${{ secrets.FEISHU_BOT_WEBHOOK }}
DRY_RUN: true或通过环境变量：
env:
DRY_RUN: "1"name: Notify on Events
on:
push:
branches: [ main ]
pull_request:
types: [ opened, synchronize, closed ]
issues:
types: [ opened, closed ]
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Send notification to Feishu
uses: XRSec/feishu-bot-webhook-action@v1
with:
FEISHU_BOT_WEBHOOK: ${{ secrets.FEISHU_BOT_WEBHOOK }}
FEISHU_BOT_SIGNKEY: ${{ secrets.FEISHU_BOT_SIGNKEY }}| 参数名 | 必需 | 描述 |
|---|---|---|
FEISHU_BOT_WEBHOOK |
是 | 飞书机器人的 webhook URL |
FEISHU_BOT_SIGNKEY |
否 | 飞书机器人的签名密钥 |
MSG_TEXT |
否 | 要发送的 Markdown 消息内容。如果不为空，将发送简化的 Markdown 卡片；否则发送 GitHub 事件模板消息 |
DRY_RUN |
否 | 仅打印将要发送的消息而不实际发送（true/1） |
你也可以通过环境变量来设置参数：
FEISHU_BOT_WEBHOOK: 飞书机器人的 webhook URLFEISHU_BOT_SIGNKEY: 飞书机器人的签名密钥MSG_TEXT: Markdown 消息内容DRY_RUN: 设置为true/1仅打印最终 JSON，不实际发送
当设置 MSG_TEXT 时，将发送包含 Markdown 内容的交互式卡片：
{
"msg_type": "interactive",
"card": {
"elements": [
{
"tag": "markdown",
"content": "您的 Markdown 内容"
}
]
}
}用户可以直接在 Markdown 中编写链接，如 [链接文本](http://example.com)，无需额外处理。
当 MSG_TEXT 为空时，将发送预设的 GitHub 事件模板卡片，包含：
- 项目名称
- 事件类型
- 分支信息
- 提交信息（显示前16位）
- 最近一次提交内容
- 操作人
- 状态
- 查看详情链接（优先指向当前工作流运行页面，否则为提交链接）
- 在飞书中创建一个机器人
- 获取 webhook URL（例如
https://open.feishu.cn/open-apis/bot/v2/hook/xxx） - 如果需要签名验证，获取签名密钥
- 在 GitHub 仓库的 Settings > Secrets and variables > Actions 中添加以下 secrets：
FEISHU_BOT_WEBHOOK: 你的 webhook URLFEISHU_BOT_SIGNKEY: 你的签名密钥（可选）
# 安装依赖
npm install
# 构建项目
npm run build- 设置环境变量：
export FEISHU_BOT_WEBHOOK='https://open.feishu.cn/open-apis/bot/v2/hook/your-webhook-id' export FEISHU_BOT_SIGNKEY='your-sign-key' # 可选 export MSG_TEXT='## 测试消息\n\n这是一条测试消息！' # 可选
- 用 dry-run 检查 JSON：
DRY_RUN=1 node dist/index.js
- 或实际发送：
node dist/index.js
- 确保飞书机器人的 webhook URL 格式正确
- 如果使用签名验证，请确保签名密钥正确；Action 会在请求 URL 上附加
timestamp与sign - 自定义消息使用简化的 Markdown 卡片格式，模板消息使用复杂的交互式卡片
- 模板消息会自动根据 GitHub 事件生成
ISC
Feishu Bot Webhook Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Feishu Bot Webhook Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.