Plugin API

[bkeepers]

Before the first release, there should be a clearly defined plugin API and easy way to create new behaviors as node packages. The plugin API should have convenience methods for performing common actions on the item that triggered the event (e.g. comment on a PR, update statuses, apply labels, etc.).

The naive example in the README right now is something like this:

robot.on('pull', function(event) {
  robot.comment("Thanks for the pull request! We'll review it within 72 hours!");
});

The first behavior is looking something like this:

module.exports = {
  webhook: 'issues', // name of webhook event
  action: function(event, github) {
    // event - the webhook event
    // github - API client: https://mikedeboer.github.io/node-github/
  }
};

I'm planning to implement a few other behaviors before figuring out what the API should look like.

[bkeepers]

Here's the new plugin API:

module.exports = robot => {
  robot.on('push', event => console.log(event));
};

Which you run with

$ probot ./index.js

🎩 @groundwater