{"id":25475221,"url":"https://github.com/chiaweilee/egg-github-webhook","last_synced_at":"2026-04-26T22:31:15.139Z","repository":{"id":144067609,"uuid":"196482644","full_name":"chiaweilee/egg-github-webhook","owner":"chiaweilee","description":"🥚Egg plugin for processing GitHub Webhooks.","archived":false,"fork":false,"pushed_at":"2019-10-24T23:35:27.000Z","size":20,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-17T23:39:26.248Z","etag":null,"topics":["egg","egg-plugin","github","webhooks"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chiaweilee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-12T00:39:58.000Z","updated_at":"2019-10-24T23:35:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"6aa710f9-b30d-4d80-878d-79ca2f3ae796","html_url":"https://github.com/chiaweilee/egg-github-webhook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chiaweilee/egg-github-webhook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiaweilee%2Fegg-github-webhook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiaweilee%2Fegg-github-webhook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiaweilee%2Fegg-github-webhook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiaweilee%2Fegg-github-webhook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chiaweilee","download_url":"https://codeload.github.com/chiaweilee/egg-github-webhook/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chiaweilee%2Fegg-github-webhook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32315711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T21:09:39.134Z","status":"ssl_error","status_checked_at":"2026-04-26T21:09:21.240Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["egg","egg-plugin","github","webhooks"],"created_at":"2025-02-18T11:54:34.622Z","updated_at":"2026-04-26T22:31:15.133Z","avatar_url":"https://github.com/chiaweilee.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [egg-github-webhook](#) \u0026middot; [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/chiaweilee/egg-github-webhook/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/egg-github-webhook.svg?style=flat)](https://www.npmjs.com/package/egg-github-webhook) [![npm downloads](https://img.shields.io/npm/dm/egg-github-webhook.svg)](https://npmcharts.com/compare/egg-github-webhook?minimal=true) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#)\n\n🥚Egg plugin for processing GitHub Webhooks. \n\n## Installation\n\n```\nnpm install egg-github-webhook\n```\n\n## BeforeUse\n\n*Content type must be `application/json`, `application/x-www-form-urlencoded` won't work at present.*\n\n## Usage\n\n```js\n// plugin.js\ngithubWebhook: {\n  enable: true,\n  package: 'egg-github-webhook',\n}\n```\n\n```js\n// config.default.js\ngithubWebhook: {\n  path: '/',\n  secret: 'your-github-webhook-password',\n  event: {\n    // a js path\n    push: './scripts/githook.js',\n    // or a function\n    push: function (event) {\n      // do sth\n    },\n  }\n}\n```\n\n*tips: It is possiable to use YAML.*\n\n## Options\n\noption | intro | type |  default  | |\n-|-|-|-\npath | Path of Payload URL | string | |\nsecret | secret | string | |\nevent | event object | object\u003cFunction\u003e | object\u003cstring\u003e | |\n\n## Example\n\n```js\nevent: {\n  push: function(event) {\n    if (event.payload) {\n      const { ref, commits } = event.payload;\n\n      if (ref === 'refs/heads/master') {\n        if (!commits.every(commit =\u003e commit.message !== 'build: release')) {\n          cmd.run('git pull');\n        }\n      }\n    }\n  };\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchiaweilee%2Fegg-github-webhook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchiaweilee%2Fegg-github-webhook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchiaweilee%2Fegg-github-webhook/lists"}