skyhook

镜像概述

skyhook 是一个用于解析各类服务提供商的 webhook 并将其转换为 *** 兼容格式进行转发的工具。通过简单的 URL 转换，即可将不同服务的事件通知集成到 *** 频道，方便团队实时监控和协作。

核心功能与特性

• 多提供商支持：兼容 20+ 主流服务提供商的 webhook 格式，包括 CI/CD 工具、代码托管平台、监控服务等
• 简单配置：仅需修改 *** webhook URL 即可完成设置，无需复杂的额外配置
• 轻量部署：支持通过 Docker 快速部署，适合本地测试和生产环境使用
• 开源可扩展：支持通过贡献代码添加新的服务提供商，或提交需求issue请求支持

支持的服务提供商

使用场景

• 开发团队监控 CI/CD 流程（如 Travis、CircleCI、Jenkins 构建结果）
• 代码仓库事件跟踪（如 GitLab、BitBucket 的代码提交、PR 变更）
• 服务状态与告警通知（如 Uptime Robot、NewRelic 的监控告警）
• 项目管理工具集成（如 Jira、Trello 的任务状态更新）

使用方法与配置说明

基本设置步骤

1. 创建 *** Webhook
   进入 *** 服务器设置 → Webhooks → 创建 Webhook，复制生成的 Webhook URL。

2. 转换为 skyhook URL
   将 *** Webhook URL 中的 ***app.com 替换为 skyhookapi.com：

   # 原始 *** URL
   [***]
   
   # 转换后的 skyhook URL
   [***]
   

3. 添加服务提供商路径
   在转换后的 URL 末尾添加目标服务提供商的路径（如 /gitlab、/jenkins）：

   [***]
   

   将此 URL 配置到对应服务的 webhook 设置中即可。

本地测试与部署

使用 Docker 运行

bash
docker run -it --rm -p 8080:8080 commit451/skyhook

• 参数说明：
  -p 8080:8080：将容器的 8080 端口映射到主机的 8080 端口，用于接收 webhook 请求
  --rm：容器退出后自动删除
  -it：交互式运行，方便查看日志输出

本地源码运行（开发用）

bash
# 构建
npm build

# 启动服务
npm start

# 运行测试
npm test

贡献与扩展

• 添加新提供商：参考 创建新提供商文档 提交 PR
• 需求反馈：通过 GitHub Issues 提交新提供商支持请求

许可证

skyhook 基于 MIT 许可证开源，详见 LICENSE 文件。