microbot

microbot

Cyborg microbot that posts a comment to a GitHub issue.

Install

Install with npm:

$ npm install --save microbot

Install with yarn:

$ yarn add microbot

Usage

var comment = require('microbot')();

API

.comment

Cyborg microbot plugin for making a comment on a GitHub issue.

Params

• config {Object}: Configuration object for passing authentication information to bot-github-auth.
• returns {Function}: Plugin function that may be used in a Promise chain.

Example

// given an issue opened event payload
return Promise.resolve(payload)
  .then(comment(function(payload) {
    return "Hi " + payload.issue.user.login;
  }))
  .then(function(response) {
    console.log(response.results);
    //=> GitHub response payload
  });

About

Contributing

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2017, Brian Woodward. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on May 23, 2017.