tristankechlo/github-webhook-parser
Composer 安装命令:
composer require tristankechlo/github-webhook-parser
包简介
can parse a recieved json from github's webhook service
README 文档
README
can parse a recieved json from github's webhook service
currently supported events
| event type | description | possible activity |
|---|---|---|
| create | A Git branch or tag is created. | |
| delete | A Git branch or tag is deleted. | |
| fork | A user forks a repository. | |
| gollum | A wiki page has been edited or created. | |
| issue_comment | Activity related to comments on issues or pull requests. | created, deleted, edited |
| issues | Activity related to an issue. | assigned, closed, deleted, demilestoned, edited, labeled, locked, milestoned, opened, pinned, reopened, transferred, unassigned, unlabeled, unlocked, unpinned |
| label | Activity related to a label. | created, deleted, edited |
| ping | A new webhook was added to the repository or organization. | |
| pull_request | Activity related to a pull request. | assigned, auto_merge_disabled, auto_merge_enabled, closed, converted_to_draft, demilestoned, dequeued, edited, enqueued, labeled, locked, milestoned, opened, ready_for_review, reopened, review_request_removed, review_requested, synchronize, unassigned, unlabeled, unlocked |
| push | Commits are pushed to a repository. | |
| release | Activity related to a release. | created, deleted, edited, prereleased, published, released, unpublished |
| repository | Activity related to the repository. | archived, created, deleted, edited, privatized, publicized, renamed, transferred, unarchived |
| star | A user stars or unstars a repository. | created, deleted |
| watch | A user started watching a repository | started |
Source
https://github.com/octokit/webhooks/
Usage
<?php # index.php require_once __DIR__ . "/vendor/autoload.php"; use TK\GitHubWebhook\WebhookHandler; use TK\GitHubWebhook\Exception\SignatureMismatchException; use TK\GitHubWebhook\Exception\WebhookException; use TK\GitHubWebhook\Exception\WebhookParseException; try { $handler = new WebhookHandler(); $handler->setSecret("**************"); // the same secret you entered while creating the webhook on github.com $handler->registerHandler(new \Your\Custom\PingHandler()); $handler->handle(); } catch (SignatureMismatchException $e) { header("HTTP/1.1 401 Unauthorized"); exit($th->getMessage()); } catch (\Throwable | WebhookException | WebhookParseException $e) { header("HTTP/1.1 400 Bad Request"); exit($e->getMessage()); }
<?php # PingHandler.php namespace Your\Custom; use TK\GitHubWebhook\Event\EventTypes; use TK\GitHubWebhook\Event\PingEvent; use TK\GitHubWebhook\Handler\EventHandlerInterface; use TK\GitHubWebhook\Request; use TK\GitHubWebhook\Response; class PingHandler implements EventHandlerInterface { public function getTargetEvent(): array { return [EventTypes::PING]; } public function handleEvent(Request $request, Response $response): Response { if ($request->event instanceof PingEvent) { $response->setStatusCode(200); $response->setMessage("Pong!"); return $response; } // do stuff with the input $response->setStatusCode(200); $response->setMessage("Not Used"); return $response; } }
tristankechlo/github-webhook-parser 适用场景与选型建议
tristankechlo/github-webhook-parser 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 36 次下载、GitHub Stars 达 0, 最近一次更新时间为 2024 年 07 月 02 日, 在 PHP 生态内属于活跃度较高的组件。
我们在过去多个企业项目中使用过 tristankechlo/github-webhook-parser 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 tristankechlo/github-webhook-parser 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
统计信息
- 总下载量: 36
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 9
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2024-07-02