tei187 / github-discord-webhook
该包的最新版本(v1.0.0)没有可用的许可证信息。
v1.0.0
2024-09-28 19:07 UTC
This package is auto-updated.
Last update: 2024-09-28 19:12:55 UTC
README
此项目实现了GitHub和Discord之间的webhook集成。它允许从同一脚本处理不同存储库和Discord频道的多个webhook。
特性
- GitHub和Discord之间无缝集成
- 针对不同的GitHub事件自定义通知
- 易于设置和配置
设置
- 在你的Discord服务器中注册一个新的webhook。有关如何操作的更多信息,请点击此处。
- 在
config\webhooks.php
文件中配置你的webhook。<?php return [ // webhook name that will be used in payload URL in GitHub 'sample-webhook' => [ // Discord webhook URL 'url' => 'https://discord.com/api/webhooks/(...)', // GitHub secret key 'secret' => 'your-github-secret-key', // Array of repositories to filter through // May be left empty to listen to all repositories 'repos' => [ 'username/repository-name' ], ] ];
- 设置其他配置文件(或如果你想使用默认设置,只需删除
.example
扩展名)。 - 在你的GitHub存储库中注册一个新的webhook。有关注册webhook的更多信息,请点击此处。
- 输入你的有效负载URL。如果你的这个包托管在例如
http://example.com/webhook
下,那么有效负载URL应该是http://example.com/webhook/sample-webhook
。 - 选择
"application/json"
作为内容类型。 - 选择你的密钥并确保将其复制到某个地方,或者更新
config\webhooks.php
中的'secret'键。 - 或者选择你想要监听的事件。
- 输入你的有效负载URL。如果你的这个包托管在例如
- 信或不信,就是这样。
更多设置
所有配置选项都位于config
目录中。在那里,你可以设置用于处理消息、有效负载和webhook的类。此外,还有一个配置文件设置允许的事件和操作。
用法
一旦设置好,你将在Discord服务器中收到有关以下事件的通知
- 提交
- 标签
- 版本
- 分支
未来的计划包括
- 分支
- 拉取请求
- 问题
- 评论
- 等等!
许可证
此项目受MIT许可证的许可 - 有关详细信息,请参阅LICENSE文件。