在开发前端应用时，我们经常需要使用 GitHub Webhooks 功能来实现自动化部署、自动化测试等服务。为了简化这个过程，我们可以使用 node-github-webhook 这个 npm 包来帮助我们快速搭建一个 Webhooks 服务端。
什么是 node-github-webhook
node-github-webhook 是一款 Node.js 的库，用于处理 GitHub Webhooks 请求。它提供了简单明了的 API，帮助我们快速搭建一个 Webhooks 服务端，处理 GitHub 仓库的 Push、Pull-request 等事件。
此外，它还支持自定义事件和操作，可以通过配置不同的事件和操作来处理不同类型的 GitHub Webhooks 请求。
安装 node-github-webhook
使用 npm 包管理工具可以方便的安装 node-github-webhook，我们可以通过下面的方式进行安装：
--- ------- ------ -------------------
使用 node-github-webhook
下面我们通过一个简单的例子来演示如何使用 node-github-webhook。
创建 Webhooks 服务
首先，我们需要创建一个 Express.js 应用，在应用中引入 node-github-webhook，创建一个 GitHub Webhooks 的监听器。具体代码如下：
----- ------- - ------------------ ----- - ------------- - - ------------------------------ ----- --- - --------- ----- ------- - --------------- ----- ----------- ------- ------------- -- ----------------------- ----------------
在这段代码中，我们创建了一个 Express.js 应用，创建了一个 GitHub Webhooks 的监听器 handler，该监听器监听路径为 /webhook，同时使用了 github 的 Webhooks 密钥可选项 secret。
处理事件
接下来，我们需要在监听器中添加相应的事件处理方法，例如处理 Push 事件的操作函数：
------------------ ----- ------- ----- ------- -- - --------------------- - ---- ----- --- -------------------------- -- ---------------------- -- -- --------- ----- --------- - ---- ----- --
在上述代码中，我们使用 .on() 方法来监听 Push 事件，当接收 Push 事件后，就会触发 async (event, repo, logger) 这个回调函数，我们可以在该函数内实现自定义的 Push 事件处理逻辑。
为了方便调试，我们使用了 log 输出，这里的 repo 指的是 GitHub 上的仓库对象，event 是事件对象，logger 是一个 bunyan 的 logger 对象，所有操作在 handler 内的回调函数中处理。
除了 Push 事件之外，我们还可以监听其他的事件，如 Pull-request 事件等，具体的事件列表可以参考 node-github-webhook 文档。
启动服务
最后我们还需要启动服务并监听端口号：
---------------- -- -- - --------------------- ------ -- ------- -- ------ --
到这里，我们就实现了一个简单的 GitHub Webhooks 服务端。当收到 GitHub Webhooks 请求时，node-github-webhook 会先验证 payload 的签名，如果签名验证不通过则会返回 403 状态码。
总结
通过本文，我们学习了如何使用 npm 包 node-github-webhook 快速搭建一个 GitHub Webhooks 服务端，以实现自动化部署、自动化测试等功能。
除此之外，我们通过示例代码了解了如何监听 GitHub Webhooks 的不同事件，并在相应的回调函数中处理自定义的业务逻辑。
最后，我们建议大家多尝试和实践，进一步提高自己的前端技术水平。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60055b9e81e8991b448d93f6