assemble / assemblebot

Bot for responding to github issues opened on assemble repositories.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

assemblebot NPM version Build Status

Bot for responding to github issues opened on assemble repositories.

Install

Install with npm:

$ npm install assemblebot --save

Usage

var AssembleBot = require('assemblebot');

API

AssembleBot

Main class for creating a new AssembleBot instance. This bot extends GithubBot and creates an instance of assemble-core that can be used to render response templates.

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: 'xxxxxxxxxxxxxxx'});

Handlers

This bot implements the following github webhook event handlers:

Related projects

  • assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… 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

Contributing

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

Building docs

Generate readme and API documentation with [verb][]:

$ npm install verb && npm run docs

Or, if [verb][] is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

License

Copyright © 2016 Brian Woodward Released under the MIT license.


This file was generated by verb, v0.9.0, on March 16, 2016.

About

Bot for responding to github issues opened on assemble repositories.

License:MIT License


Languages

Language:JavaScript 93.9%Language:HTML 6.1%