github-comment-manager v1.1.5

Github Comment Manager

Overview

The Github Comment Manager makes interacting with Github comments easier. This module exposes four functions allowing you to create, read, update and remove comments.

Functions

Create

The create function will create a single review comment on a Github pull request.

import { create } from 'github-comment-manager';

create.comment({account, token, repository, pullRequest, comment});

Read

The read function will return a list of review comments on a pull request.

import { read } from 'github-comment-manager';

read.comments({account, token, repository, pullRequest});

The example response can be found HERE.

Update

The update function will update a specific review comment on a Github pull request.

import { update } from 'github-comment-manager';

update.comment({account, token, repository, commentId, updatedComment});

Remove

The remove function will remove a specific review comment on a Github pull request.

import { remove } from 'github-comment-manager';

remove.comment({account, token, repository, commentId});

Contributing

Please see the contribution document for further details.