WebHook 项目使用教程

1. 项目目录结构及介绍

WebHook 项目是一个轻量级的 HTTP WebHook 服务工具，其目录结构如下：

webhook/
├── .gitignore          # Git 忽略文件配置
├── .goreleaser.yaml    # GoReleaser 配置文件
├── Dockerfile          # Docker 构建文件
├── LICENSE             # MIT 许可证文件
├── README.md           # 项目说明文件
├── README-zhCN.md      # 项目说明文件（中文）
├──SECURITY.md          # 安全策略文件
├── go.mod              # Go 依赖管理文件
├── go.sum              # Go 依赖校验文件
├── webhook.go          # WebHook 主程序文件
├── webhook_test.go     # WebHook 测试文件
├── hooks.json          # 默认配置文件（JSON 格式）
├── hooks.yaml          # 默认配置文件（YAML 格式）
└── internal/           # 内部实现代码目录

• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• .goreleaser.yaml: 配置 GoReleaser 自动发布版本。
• Dockerfile: 用于构建 Docker 容器的配置文件。
• LICENSE: 项目使用的 MIT 许可证。
• README.md 和 README-zhCN.md: 分别是项目的英文和中文说明文件。
• SECURITY.md: 提供项目安全策略信息。
• go.mod 和 go.sum: 管理项目依赖的 Go 模块。
• webhook.go: WebHook 服务的主程序。
• webhook_test.go: 对 WebHook 服务的单元测试。
• hooks.json 和 hooks.yaml: 配置 WebHook 服务的钩子。

2. 项目的启动文件介绍

项目的启动文件是 webhook.go。该文件包含了 WebHook 服务的主函数，用于启动 HTTP 服务并监听来自客户端的请求。以下是启动文件的主要组成部分：

• 初始化配置解析器。
• 设置 HTTP 服务监听的地址和端口。
• 加载配置文件，定义钩子行为。
• 设置请求的路由处理。
• 启动 HTTP 服务。

3. 项目的配置文件介绍

项目的配置文件是 hooks.json 和 hooks.yaml。这两个文件定义了 WebHook 服务的钩子配置，决定了服务的行为和响应方式。

配置文件中可以定义以下内容：

• id: 钩子的唯一标识符。
• execute-command: 当钩子被触发时，将要执行的命令。
• command-working-directory: 执行命令时使用的 working directory。
• trigger-rule: 定义触发钩子的规则，如 HTTP 方法、请求路径、请求头等。

配置文件示例（JSON 格式）：

[
    {
        "id": "example-hook",
        "execute-command": "/path/to/command",
        "command-working-directory": "/path/to/working/dir",
        "trigger-rule": {
            "method": ["GET", "POST"],
            "path": "/hooks/example-hook"
        }
    }
]

配置文件示例（YAML 格式）：

- id: example-hook
  execute-command: /path/to/command
  command-working-directory: /path/to/working/dir
  trigger-rule:
    method:
      - GET
      - POST
    path: /hooks/example-hook

通过编辑配置文件，可以自定义 WebHook 服务的功能和行为，以适应不同的使用场景。