如何在没有事件的情况下触发 WebHooks - Probot Github App

Probot 是一个用于编写 Github 应用程序的 JavaScript 框架。它使得编写 Github 应用程序变得更加容易和愉快。在本文中，我们将了解如何使用 Probot 框架来在没有事件的情况下触发 WebHooks。

什么是 WebHooks？

WebHooks 是一种机制，让 Web 应用程序通过 HTTP 请求在接收方注册一个 URL，以便在将来发生特定事件时接收通知。例如，当代码库中发生某个事件时，Github WebHooks 可以通过发送 HTTP POST 请求来通知您的应用程序。

Probot 库

Probot 是一个基于 Node.js 的框架，它使用 Github WebHooks 和 Github REST API 来创建自定义 Github 应用程序。这个库简化了很多任务，使得开发者可以专注于应用程序的逻辑，而不需要处理 Github API 或 WebHooks 的底层细节。

触发 WebHooks

除了处理 Github WebHooks，Probot 还支持通过应用程序自己的代码调用 WebHooks。这种方式被称为“人为触发 WebHooks”。

以下是如何在没有事件的情况下触发 WebHook 的代码：

robot.log('触发 WebHook')

const res = await robot.http({
  method: 'POST',
  url: 'https://api.github.com/repos/user/repo/hooks/1234/pings',
  headers: {
    Accept: 'application/vnd.github.v3+json',
    Authorization: `token ${process.env.GITHUB_TOKEN}`,
  },
})

robot.log.debug(res)

该代码片段首先使用机器人对象的 http 方法创建一个 HTTP POST 请求。在这里，我们使用 Github REST API 中的 ping 路径来触发 WebHook。

在这个例子中，我们给 HTTP 请求提供了必要的请求头（包括 Github API 版本和访问令牌），并通过机器人对象的 log 方法记录请求响应。log.debug 方法将响应对象打印到 Probot 日志中，以便您可以查看 API 的响应并调试应用程序逻辑。

结论

在本文中，我们学习了如何使用 Probot 框架来触发 Github WebHooks。通过使用 Probot 框架和 Github REST API，我们可以快速轻松地编写自定义 Github 应用程序。最后，请务必按照上面的代码片段在应用程序中进行人为 WebHook 触发时小心，防止不必要的影响和干扰。