Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 3.08 KB

README.md

File metadata and controls

88 lines (53 loc) · 3.08 KB

Repo2Kook

PyPI PyPI - License pdm-managed Zeabur-Deployed
优雅地转发 GitHub Webhook 事件到 Kook

📷 截图

issue example pr example push example comment example

🔨 使用

使用 Zeabur 上部署的公用服务

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

具体步骤 👇
  1. 在飞书群组中添加一个 Webhook 机器人。

添加 Webhook 机器人

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

获取 Webhook

  1. 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

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

使用 Zeabur 一键部署公用版

Deploy on Zeabur

使用 Zeabur 一键部署独立版

TODO

📦 使用 Docker 部署

TODO

🔒 安全性

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

📅 支持的事件

  • push

  • pull_request

    • assigned

    • review_request

  • pull_request_review

  • pull_request_comment

  • issue

    • assigned
  • issue_comment

  • workflow_run