Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexcorvi/github-webhooks-listener

A NodeJS client (listener) for GitHub events webhooks writen in typescript
https://github.com/alexcorvi/github-webhooks-listener

github-webhooks webhooks

Last synced: about 2 months ago
JSON representation

A NodeJS client (listener) for GitHub events webhooks writen in typescript

Host: GitHub
URL: https://github.com/alexcorvi/github-webhooks-listener
Owner: alexcorvi
License: other
Created: 2017-11-12T12:55:23.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2017-11-12T13:51:28.000Z (about 7 years ago)
Last Synced: 2024-11-14T15:19:18.730Z (2 months ago)
Topics: github-webhooks, webhooks
Language: TypeScript
Size: 25.4 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        Github Webhooks Listener

================

This is a client library for listening (receiving) to GitHub Webhooks and execute a callback on them.

> Note: This client library based on the excellent [Node Github Hook](https://github.com/nlf/node-github-hook) library.

To Install:

-----------

```

npm install gh-listener

```

To Use:

-------

```typescript

import GHClient from "gh-listener";

const github = new GHClient({

  /* options: see below */

});

github.onPush((data) => {

  console.log(data.commits.map(x => x.author)); // prints the authors of the commits

});

```

## Methods and events

The library has the following methods and supports their respective events:

Method | Event | GitHub Reference

--- | --- | ---

`github.onCommitComment(cb)` | `commit_comment` | [Reference](https://developer.github.com/v3/activity/events/types/#commitcommentevent)

`github.onCreate(cb)` | `create` | [Reference](https://developer.github.com/v3/activity/events/types/#createevent)

`github.onDelete(cb)` | `delete` | [Reference](https://developer.github.com/v3/activity/events/types/#deleteevent)

`github.onDeployment(cb)` | `deployment` | [Reference](https://developer.github.com/v3/activity/events/types/#deploymentevent)

`github.onDeploymentStatus(cb)` | `deployment_status` | [Reference](https://developer.github.com/v3/activity/events/types/#deploymentstatusevent)

`github.onFork(cb)` | `fork` | [Reference](https://developer.github.com/v3/activity/events/types/#forkevent)

`github.onGollum(cb)` | `gollum` | [Reference](https://developer.github.com/v3/activity/events/types/#gollumevent)

`github.onInstallation(cb)` | `installation` | [Reference](https://developer.github.com/v3/activity/events/types/#installationevent)

`github.onInstallationRepository(cb)` | `installation_repository` | [Reference](https://developer.github.com/v3/activity/events/types/#installationrepositoryevent)

`github.onIssueComment(cb)` | `issue_comment` | [Reference](https://developer.github.com/v3/activity/events/types/#issuecommentevent)

`github.onIssue(cb)` | `issue` | [Reference](https://developer.github.com/v3/activity/events/types/#issueevent)

`github.onLabel(cb)` | `label` | [Reference](https://developer.github.com/v3/activity/events/types/#labelevent)

`github.onMembership(cb)` | `membership` | [Reference](https://developer.github.com/v3/activity/events/types/#membershipevent)

`github.onMilestone(cb)` | `milestone` | [Reference](https://developer.github.com/v3/activity/events/types/#milestoneevent)

`github.onOrganization(cb)` | `organization` | [Reference](https://developer.github.com/v3/activity/events/types/#organizationevent)

`github.onOrganizationBlock(cb)` | `organizationBlock` | [Reference](https://developer.github.com/v3/activity/events/types/#organizationblockevent)

`github.onPageBuild(cb)` | `page_build` | [Reference](https://developer.github.com/v3/activity/events/types/#pagebuildevent)

`github.onPullRequest(cb)` | `pull_request` | [Reference](https://developer.github.com/v3/activity/events/types/#pullrequestevent)

`github.onPullRequestReview(cb)` | `pull_request_review` | [Reference](https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent)

`github.onPullRequestReviewComment(cb)` | `pull_request_review_comment` | [Reference](https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent)

`github.onPush(cb)` | `push` | [Reference](https://developer.github.com/v3/activity/events/types/#pushevent)

`github.onRelease(cb)` | `release` | [Reference](https://developer.github.com/v3/activity/events/types/#releaseevent)

`github.onRepository(cb)` | `repository` | [Reference](https://developer.github.com/v3/activity/events/types/#repositoryevent)

`github.onStatus(cb)` | `status` | [Reference](https://developer.github.com/v3/activity/events/types/#statusevent)

`github.onWatch(cb)` | `watch` | [Reference](https://developer.github.com/v3/activity/events/types/#watchevent)

## Options

Available options are:

* **host**: the host to listen on, defaults to '0.0.0.0'

* **port**: the port to listen on, defaults to 3420

* **path**: the path for the GitHub callback, defaults to '/github/callback'

* **wildcard**: if true, the path for the GitHub callback will be considered valid as long as it *starts* with the configured path

* **secret**: if specified, you must use the same secret in your webhook configuration in GitHub. if a secret is specified, but one is not configured in GitHub, the hook will fail. if a secret is *not* specified, but one *is* configured in GitHub, the signature will not be validated and will be assumed to be correct. consider yourself warned. this option can also be a function that takes the following parameters: (request, data, callback). callback is error first and should be passed (err, secret)

* **logger**: an optional instance of a logger that supports the "log" and "error" methods and one parameter for data (like console), default is `console`.

* **https**: Options to pass to nodejs https server. If specified, you must follow documentation about nodejs https library (See options in https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener)

* **trustProxy**: By default the `x-forwarded-for` header is trusted when determining the remoteAddress to log for a request. Set this to `false` to disable this behavior

* **enableHealthcheck**: Respond to GET requests with a 204 response for healthcheck purposes

* **healthcheckCode**: Override the 204 status code for healthchecks (for systems that aren't friendly with HTTP spec compliance and want a 200, for example)

```typescript

new GHClient({

	enableHealthcheck: false,

	healthcheckCode: 200,

	host: '0.0.0.0',

	https: {

		ciphers: 'something'

	},

	path: 'listen',

	port: 3000,

	secret: 'mysecretkey',

	trustProxy: true,

	wildcard: true

});

```

License

=======

MIT