Github.commentOnIssue()

Comment on an issue on GitHub.

Creates a comment in the issue with the specified issue number, within the specified owner and repository.

Usage

Hover over inputs/exits for more info.

var Github = require('machinepack-github');


// Comment on an issue on GitHub.

Github.commentOnIssue({

owner: 'balderdashy',

repo: 'sails',

issueNumber: 237,

comment: 'Thanks @cherrybear. Do _you_ have a link to the PR?',

: ,

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// OK.

success: function (newCommentId) {

 

},

});

Inputs

owner required

The name of the organization or user that owns the repo (i.e. as it appears in the URL on GitHub)

'balderdashy'
repo required

The name of the Github repo (i.e. as it appears in the URL on GitHub)

'sails'
issueNumber required

The number of the issue to comment on.

237
comment required

The contents of the comment.

'Thanks @cherrybear.  Do _you_ have a link to the PR?'
undefined

Exits

error

An unexpected error occurred.

success

OK.

141755181