开源项目 `octokit/webhooks.js` 使用教程

开源项目 octokit/webhooks.js 使用教程

webhooks.jsGitHub webhook events toolset for Node.js项目地址:https://gitcode.com/gh_mirrors/we/webhooks.js

1. 项目的目录结构及介绍

octokit/webhooks.js 是一个用于处理 GitHub webhook 事件的 Node.js 工具集。项目的目录结构如下：

/octokit/webhooks.js
├── src
│   ├── index.js
│   ├── middleware.js
│   ├── event-handler.js
│   ├── verify.js
│   └── ...
├── test
│   ├── index.test.js
│   ├── middleware.test.js
│   ├── event-handler.test.js
│   ├── verify.test.js
│   └── ...
├── package.json
├── README.md
└── ...

目录结构介绍

• src: 包含项目的主要源代码文件。
  • index.js: 项目的入口文件。
  • middleware.js: 用于创建处理 webhook 请求的中间件。
  • event-handler.js: 处理不同类型的 webhook 事件。
  • verify.js: 用于验证 webhook 签名的模块。
• test: 包含项目的测试文件。
  • index.test.js: 对入口文件的测试。
  • middleware.test.js: 对中间件的测试。
  • event-handler.test.js: 对事件处理器的测试。
  • verify.test.js: 对验证模块的测试。
• package.json: 项目的配置文件，包含依赖、脚本等信息。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件主要负责初始化 Webhooks 实例并设置事件监听器。以下是 index.js 的主要内容：

import { Webhooks, createNodeMiddleware } from "@octokit/webhooks";
import { createServer } from "node:http";

const webhooks = new Webhooks({
  secret: "mysecret"
});

webhooks.onAny(({ id, name, payload }) => {
  console.log(name, "event received");
});

createServer(createNodeMiddleware(webhooks)).listen(3000);

启动文件介绍

• Webhooks 实例: 通过 new Webhooks({ secret: "mysecret" }) 创建一个 Webhooks 实例，其中 secret 是用于验证 webhook 签名的密钥。
• 事件监听器: 使用 webhooks.onAny 方法监听所有类型的 webhook 事件，并在控制台输出事件名称。
• 创建服务器: 使用 createServer 和 createNodeMiddleware 创建一个 HTTP 服务器，监听端口 3000。

3. 项目的配置文件介绍

项目的配置文件是 package.json。这个文件包含了项目的元数据、依赖项、脚本等信息。以下是 package.json 的主要内容：

{
  "name": "@octokit/webhooks",
  "version": "9.13.0",
  "description": "GitHub webhook events toolset for Node.js",
  "main": "dist-src/index.js",
  "types": "dist-src/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest",
    "lint": "eslint src test"
  },
  "dependencies": {
    "@octokit/webhooks-definitions": "^3.67.3",
    "debug": "^4.3.3",
    "is-plain-object": "^5.0.0",
    "jsonwebtoken": "^8.5.1",
    "lodash": "^4.17.21",
    "micro-typed-emitter": "^2.1.0",
    "once": "^1.4.0"
  },
  "devDependencies": {
    "@types/jest": "^27.0.2",
    "eslint": "^7.32.0",
    "jest": "^27.2.4",
    "ts-jest": "^27.0.5",
    "typescript": "^4.4.3"
  },
  "keywords":

webhooks.jsGitHub webhook events toolset for Node.js项目地址:https://gitcode.com/gh_mirrors/we/webhooks.js