github-webhook-handler

GitHub-webhook-handler GitHub 允许您为仓库注册 Webhooks。每当仓库发生事件时，无论是推送代码、填写问题还是创建拉取请求，您注册的 Webhook 地址都可以配置为接收详细信息。 此库是用于 Node.js Web 服务器的一个小处理器（如果必须的话也可以称为“中间件”），负责接收和验证来自 GitHub 的 Webhook 请求的所有逻辑。

对于多个处理器,请参阅 多个处理器问题。

• "path": 当查看 req.url 时,匹配的完整大小写路径/路由。任何不匹配此路径的请求都会导致处理器的回调函数被调用(有时称为 next 处理器)。 * "secret": 这是用于创建 GitHub 发送的 JSON 片段的 SHA-1 HMAC 签名的哈希密钥。您应该将相同的秘密密钥注册到 GitHub 中。任何不提供与使用此密钥对片段生成的签名匹配的 X-Hub-Signature 的请求都将被拒绝,并导致 'error' 事件(回调函数也会以 Error 对象的形式调用)。 * "events": 可选的白名单事件类型数组(请参阅 events.json)。如果定义了此选项,任何不在白名单中找到 X-GitHub-Event 的入站请求都将被拒绝。如果只接受单个事件类型,此选项也可以是字符串。

生成的 handler 函数就像一个常见的"中间件"处理程序,可以插入到处理链中。它接受 request、response 和 callback 参数。如果请求被成功处理,则不调用 callback;否则,它会以 Error 或无返回值的形式调用。