0.2.0 • Published 7 years ago

node-git-webhooks v0.2.0

Weekly downloads
4
License
MIT
Repository
github
Last release
7 years ago

node-git-webhooks

The webhooks lib for code repositories based on git.

Usage

# Local install
npm i -S node-git-webhooks
const gitWebhooks = require('node-git-webhooks').default;

const options = {}; // The webhooks server optoions

// Gitlab Server
const server = new gitWebhooks.GitlabWebHooksServer(options);
// All gitlab webhooks type.
const gitlabEventType = gitWebhooks.GitlabEventType;
server.subscribe((evt, data) => {
  if (evt === gitlabEventType.Push) {
    console.log('push', data);
  } else if (evt === gitlabEventType.IssueNote) {
    console.log('issue note', data);
  }
});

// Also support Github Server
// const server = new gitWebhooks.GithubWebHooksServer(options);
// All github webhooks type.
// const githubEventType = gitWebhooks.GithubEventType;
// server.subscribe((evt, data) => {
//   if (evt === githubEventType.Push) {
//     console.log('push', data);
//   } else if (evt === githubEventType.IssueNote) {
//     console.log('issue note', data);
//   }
// });

server.onError(err => {
  console.error('Error', err);
});

// Run web hooks server at port 8000;
server.listen(8000).then(server => {
  console.log('server started...');
});

options

{
  token: string // The webhooks Secret(github) or Secret Token(gitlab)
}

Note: If use github webhooks server, should choose the application/json content-type.

How to Develop

# Clone the project
git clone <repositoty url>

# Install deps
npm i

# Run dev
npm run dev

# Run build and generate declarations.
npm run build

CHANGLOG