Basic Information

appmixer.github.list.CreateReviewComment

Create Review Comment

1.0.0

Public

Add an inline review comment to a line of a pull request diff. This is the line-anchored counterpart of Submit Review, which comments on the pull request as a whole, and of Create Comment, which posts to the pull request conversation. When no Commit SHA is given, the head commit of the pull request is used.

Input Ports

in

FieldTypeDescription
Repository text Enter the repository in `owner/repo` format (e.g. `octocat/Hello-World`). You can also pick from the dynamically loaded list of your repositories.
Pull Request Number text The number of the pull request to comment on (e.g. `1259`).
Body textarea The Markdown text of the review comment.
File Path text Path of the file to comment on, relative to the repository root (e.g. `src/lib/index.js`). The file must be part of the pull request diff.
Comment On select Anchor the comment to a line of the diff, or to the file as a whole.
Line text The line of the file the comment applies to, as numbered in the diff on the chosen side.
Side select Which side of the diff the line is on: RIGHT for the new version (added or unchanged lines), LEFT for the old one (deleted lines).
Start Line text Optional. First line of a multi-line comment; the Line input is then the last line of the range. Leave empty to comment on a single line.
Start Side select Optional. Side of the diff the start line is on. Defaults to the Side value.
Commit SHA text Optional. The SHA of the commit to anchor the comment to. Leave empty to use the head commit of the pull request.

Output Ports

out

FieldTypeDescription
ID integer -
Node ID string -
Body string -
HTML URL string -
Pull Request URL string -
Path string -
Line integer -
Side string -
Start Line integer -
Start Side string -
Commit ID string -
Diff Hunk string -
Created At string -
User object -

Full Metadata