JSPM

github-push-receive

0.2.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q17477F
  • License MIT

issue a `git push` in response to a github post-receive hook payload

Package Exports

  • github-push-receive

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-push-receive) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

github-push-receive

Issue a git push in response to a github post-receive hook payload.

example

First whip up an http server to listen for the github payloads:

var pushReceive = require('github-push-receive');
var http = require('http');

var server = http.createServer(function (req, res) {
    if (req.url.split('/')[1] === 'hook') {
        req.pipe(pushReceive('http://localhost:8051')).pipe(res);
    }
    else res.end('beep boop\n');
});
server.listen(8050);

The github payloads received by this server will be forwarded to the git server running on http://localhost:8051. You can use whichever protocol you like here since github-push-receive just shells out to git.

Just configure your github repo in the admin -> hooks part of the UI to set your server uri as a webhook endpoint.

Here's an http-based git server based on pushover you could use as a git target:

var pushover = require('pushover');
var repos = pushover('/tmp/repos');

repos.on('push', function (push) {
    console.log(
        'pushed to '
        + push.repo + '/' + push.commit
        + ' (' + push.branch + ')'
    );
    push.accept();
});

var http = require('http');
var server = http.createServer(function (req, res) {
    repos.handle(req, res);
});
server.listen(8051);

When you push code to the github repo, the git target will get pushed to.

methods

var pushReceive = require('github-push-receive')

pushReceive(target, opts={})

Return a duplex response-stream that you can pipe http request objects into and optionally pipe into http response objects.

The git payloads received as POSTS will be cloned and pushed to target.

opts.payloadMap(payload, cb) can be a function that takes a payload and transforms it asynchronously, calling cb(payload) with the result.

install

npm install github-push-receive

license

MIT