assemblebot

assemblebot

Bot for responding to github issues opened on assemble repositories.

Install

Install with npm

$ npm i assemblebot --save

Usage

var AssembleBot = require('assemblebot');

API

AssembleBot

Main class for creating a new AssembleBot instance. This bot extends GithubBot and adds sepcific handlers for responding to assemble issues.

Params

• options {Object}: Options to use to configure the bot.
• options.GITHUB_TOKEN {String}: Personal github token the bot uses to post to github issues.

Example

var bot = new AssembleBot({GITHUB_TOKEN: 'XXX'});

Handlers

This bot implements the following github webhook event handlers:

.issues

Handles responding to newely open github issues.

Will post a comment on a newely open github issue as the configured github user. Uses a template that can be rendered with the issue payload providing more context and a richer response. See the github webhook issues event for specification of payload object.

Example

bot.handleIssues(payload, function(err, results) {
  if (err) return console.error(err);
  console.log(results);
});

Related projects

• assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more | homepage
• base-bot: Simple bot that knows how to handle events when told too. Use base bot to… more | homepage
• githubbot: Starting point for registering event handlers and handling payloads coming from github webhooks. Allows usage… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2015 Brian Woodward Released under the MIT license.

This file was generated by verb on December 30, 2015.