An open API service indexing awesome lists of open source software.

https://github.com/jingfelix/repo2lark

优雅地转发 GitHub Webhook 事件到飞书。
https://github.com/jingfelix/repo2lark

feishu lark webhook

Last synced: 5 months ago
JSON representation

优雅地转发 GitHub Webhook 事件到飞书。

Awesome Lists containing this project

README

          


Repo2Lark


PyPI

PyPI - License
pdm-managed
Zeabur-Deployed

优雅地转发 GitHub Webhook 事件到飞书

## 📷 截图



issue example
pr example
push example
comment example

## 🔨 使用

### 使用 Zeabur 上部署的公用服务

公用服务版不支持使用 GitHub Webhook Secret 和飞书 Webhook Secret。优点是使用方便,仅需替换 Webhook URL 即可。

具体步骤 👇

1. 在飞书群组中添加一个 Webhook 机器人。

![添加 Webhook 机器人](https://sf3-cn.feishucdn.com/obj/open-platform-opendoc/a9f4e16ea91fd15a272b0ba926e4c2fd_k0hrjUtKqR.png?height=1106&lazyload=true&maxWidth=600&width=1652)

2. 获取飞书 Webhook URL(注:公用服务版不支持签名校验)

![获取 Webhook](https://sf3-cn.feishucdn.com/obj/open-platform-opendoc/39d1233fc3276c71f6fce9707abf05c9_YdZveIV7gm.png?height=1134&lazyload=true&maxWidth=600&width=1654)

3. GitHub Repo Settings 中填写 Webhook URL,选择需要的事件。填写 `https://webhook.zeabur.app/open-apis/bot/v2/hook/{你的飞书 Webhook Token}`(或直接将 `open.feushu.cn` 替换为 `webhook.zeabur.app`) token 位于飞书 Webhook URL 结尾,形如b8b957dc-****...

![填写 Webhook URL](assets/githubwebhook_common.png)

4. 现在,当有指定事件发生时,飞书群组中就会收到消息了。

issue example

### 使用 Zeabur 一键部署公用版

Deploy on Zeabur

### 使用 Zeabur 一键部署独立版

TODO

## 📦 使用 Docker 部署

TODO

## 🔒 安全性

使用 GitHub/飞书 Webhook Secret 可以提高安全性,但需要独立部署。

## 📅 支持的事件

- [x] push

- [x] pull_request

- [ ] assigned

- [ ] review_request

- [ ] pull_request_review

- [ ] pull_request_comment

- [x] issue

- [ ] assigned

- [x] issue_comment

- [ ] workflow_run