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事件自定义通知
  • 易于设置和配置

设置

  1. 在你的Discord服务器中注册一个新的webhook。有关如何操作的更多信息,请点击此处
  2. 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' ],
        ]
    ];
  3. 设置其他配置文件(或如果你想使用默认设置,只需删除.example扩展名)。
  4. 在你的GitHub存储库中注册一个新的webhook。有关注册webhook的更多信息,请点击此处
    1. 输入你的有效负载URL。如果你的这个包托管在例如http://example.com/webhook下,那么有效负载URL应该是http://example.com/webhook/sample-webhook
    2. 选择"application/json"作为内容类型。
    3. 选择你的密钥并确保将其复制到某个地方,或者更新config\webhooks.php中的'secret'键。
    4. 或者选择你想要监听的事件。
  5. 信或不信,就是这样。

更多设置

所有配置选项都位于config目录中。在那里,你可以设置用于处理消息、有效负载和webhook的类。此外,还有一个配置文件设置允许的事件和操作。

用法

一旦设置好,你将在Discord服务器中收到有关以下事件的通知

  • 提交
  • 标签
  • 版本
  • 分支

未来的计划包括

  • 分支
  • 拉取请求
  • 问题
  • 评论
  • 等等!

许可证

此项目受MIT许可证的许可 - 有关详细信息,请参阅LICENSE文件。