ErisPulse-GitHubWebhook

GitHub Webhook 聚合器模块，支持将 GitHub 事件转发到聊天平台。

功能特性

支持多种 GitHub 事件（push、issues、pull_request、release、star、fork）
交互式命令管理 Webhook 配置
支持群聊和私聊两种场景
消息去重机制
签名验证（可选）
历史记录查询
多平台适配（云湖、Telegram、QQ 等）

安装

epsdk install GitHubWebhook

配置

在 config.toml 中添加以下配置：

[GitHubWebhook]
# 外部可访问的基础地址（必填）
# 示例: http://your-domain.com 或 https://your-ip:8080
base_url = "http://localhost:8080"

# 历史记录保留时间（天），默认 7 天
history_ttl = 7

# 去重标记过期时间（秒），默认 3600 秒（1小时）
dedup_ttl = 3600

# 错误通知限流时间（秒），默认 300 秒（5分钟）
error_ratelimit = 300

# 最大历史记录数，默认 100 条
max_history_records = 100

使用方法

1. 添加 Webhook 监听

发送命令：

/ghw_add

按照提示输入：

仓库名称（如：myorg/myproject）
要监听的事件（push、issues、pr、release、star、fork、workflow，多个用逗号分隔）
Webhook Secret（可选，发送空格或 skip 跳过）

配置成功后会返回 Webhook URL，例如：

配置成功！

Webhook URL: http://localhost:8080/GitHubWebhook/github-webhook/G1001_a3f2

请在 GitHub 仓库设置中配置：
- Payload URL: 上面的 URL
- Content type: application/json
- Secret: （可选，发送空格或 skip 跳过）
- Events: 选择需要的事件类型

2. 列出所有监听

发送命令：

/ghw_list

会显示当前群组/用户配置的所有 Webhook 监听。

3. 删除监听

发送命令：

/ghw_remove

按照提示选择要删除的监听配置。

4. 查看历史记录

发送命令：

/ghw_history

按照提示选择要查看历史的仓库，会显示该仓库的最近事件记录。

支持的事件类型

事件类型	说明	显示内容
push	代码推送	仓库、分支、提交者、提交数量、提交消息预览
issues	Issue 创建/编辑/关闭	操作类型、标题、创建者、Issue 链接
pull_request	PR 打开/合并/关闭	操作类型、PR 标题、发起者、分支信息、链接
release	发布版本	版本号、发布者、描述、下载链接
star	收藏仓库	收藏者、仓库、Star 总数
fork	复刻仓库	复刻者、目标仓库

GitHub 配置

添加 Webhook

进入 GitHub 仓库设置页面
点击 "Webhooks" -> "Add webhook"
填写以下信息：
- Payload URL: 模块返回的 Webhook URL
- Content type: application/json
- Secret: （可选）如果配置了则填写相同的密钥
- Events: 选择需要监听的事件类型
点击 "Add webhook" 完成配置

消息格式示例

Push 事件

[GitHub] Push 到 myorg/myproject
分支: main
推送者: JohnDoe
提交数: 3

- feat: 添加新功能 (abc1234)
- fix: 修复bug (def5678)
- docs: 更新文档 (ghi9012)

查看对比: https://github.com/myorg/myproject/compare/abc1234...def5678

Issues 事件

[GitHub] Issue opened
仓库: myorg/myproject
标题: 发现一个问题
操作者: JaneDoe
Issue #123: https://github.com/myorg/myproject/issues/123

Pull Request 事件

[GitHub] Pull request opened
仓库: myorg/myproject
标题: 添加新功能
发起者: JaneDoe
分支: feature/new-feature -> main
PR #456: https://github.com/myorg/myproject/pull/456

注意事项

外部访问地址：确保 base_url 配置正确，且 GitHub 可以访问到该地址
签名验证：建议在公共网络环境启用签名验证以提高安全性
历史记录：历史记录会定期清理，避免占用过多存储空间
消息去重：模块会自动去重，避免重复通知

常见问题

Webhook 没有收到消息？

检查 GitHub Webhook 配置是否正确
在 GitHub 仓库中进行真实操作（如创建 Issue、提交代码）测试
查看模块日志确认是否有错误
检查网络连接是否正常
确认隧道服务或公网地址可被 GitHub 访问

如何删除所有监听？

多次使用 /ghw_remove 命令逐个删除，或者直接删除存储中的配置。

支持哪些平台？

支持所有 ErisPulse 适配器，包括但不限于：

云湖
Telegram
QQ (OneBot11)
邮件

开发者

wsu2059 wsu2059@qq.com

许可证

MIT License

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

erispulse_githubwebhook-1.2.1.tar.gz (15.5 kB view details)

Uploaded May 3, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

erispulse_githubwebhook-1.2.1-py3-none-any.whl (17.2 kB view details)

Uploaded May 3, 2026 Python 3

File details

Details for the file erispulse_githubwebhook-1.2.1.tar.gz.

File metadata

Download URL: erispulse_githubwebhook-1.2.1.tar.gz
Upload date: May 3, 2026
Size: 15.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for erispulse_githubwebhook-1.2.1.tar.gz
Algorithm	Hash digest
SHA256	`d8f44f1c63215079d44504d89335e423ae3b327d788bec0630dd17d962d0e05a`
MD5	`c1d3401a43b6596e9d6d7860110a6bdf`
BLAKE2b-256	`d8be7eb6771e2280db802fd98984f5d663765eb832e27ced0354f6c7ef344ab5`

See more details on using hashes here.

Provenance

The following attestation bundles were made for erispulse_githubwebhook-1.2.1.tar.gz:

Publisher: python-publish.yml on wsu2059q/ErisPulse-GitHubWebhook

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: erispulse_githubwebhook-1.2.1.tar.gz
- Subject digest: d8f44f1c63215079d44504d89335e423ae3b327d788bec0630dd17d962d0e05a
- Sigstore transparency entry: 1435937207
- Sigstore integration time: May 3, 2026
Source repository:
- Permalink: wsu2059q/ErisPulse-GitHubWebhook@b4f72906a4d0c9efa98820ae8248de174e08182c
- Branch / Tag: refs/heads/main
- Owner: https://github.com/wsu2059q
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yml@b4f72906a4d0c9efa98820ae8248de174e08182c
- Trigger Event: workflow_dispatch

File details

Details for the file erispulse_githubwebhook-1.2.1-py3-none-any.whl.

File metadata

Download URL: erispulse_githubwebhook-1.2.1-py3-none-any.whl
Upload date: May 3, 2026
Size: 17.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for erispulse_githubwebhook-1.2.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`1ebc031a8b8ce05b4f22d0ef74812344a79a4a648424eeb32d05af3f15a9906f`
MD5	`39b07c3008d9834b51996f8bea06a7c8`
BLAKE2b-256	`29ff1a348391b05688aa6ba7fc504923bbb04587a79f0bbf3b28ebe8ec9f3e0d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for erispulse_githubwebhook-1.2.1-py3-none-any.whl:

Publisher: python-publish.yml on wsu2059q/ErisPulse-GitHubWebhook

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: erispulse_githubwebhook-1.2.1-py3-none-any.whl
- Subject digest: 1ebc031a8b8ce05b4f22d0ef74812344a79a4a648424eeb32d05af3f15a9906f
- Sigstore transparency entry: 1435937212
- Sigstore integration time: May 3, 2026
Source repository:
- Permalink: wsu2059q/ErisPulse-GitHubWebhook@b4f72906a4d0c9efa98820ae8248de174e08182c
- Branch / Tag: refs/heads/main
- Owner: https://github.com/wsu2059q
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yml@b4f72906a4d0c9efa98820ae8248de174e08182c
- Trigger Event: workflow_dispatch

Release history Release notifications | RSS feed

This release

1.2.1 This release

May 3, 2026 2 files

1.1.0

Feb 28, 2026 2 files

1.0.0

Feb 26, 2026 2 files

ErisPulse-GitHubWebhook 1.2.1

ErisPulse-GitHubWebhook

功能特性

安装

配置

使用方法

1. 添加 Webhook 监听

2. 列出所有监听

3. 删除监听

4. 查看历史记录

支持的事件类型

GitHub 配置

添加 Webhook

消息格式示例

Push 事件

Issues 事件

Pull Request 事件

注意事项

常见问题

Webhook 没有收到消息？

如何删除所有监听？

支持哪些平台？

开发者

许可证

Project links

Key dates

1 maintainer

Credits

License

Requires

Download files

Source Distribution

Built Distribution

File details

File metadata

File hashes

Provenance

File details

File metadata

File hashes

Provenance

Release history Release notifications | RSS feed