github-comment-manager
Advanced tools
The Github Comment Manager makes interacting with Github comments easier. This module exposes four functions allowing you to create, read, update and remove comments.
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});
| Parameter | Description |
|---|---|
| account | Github account username |
| token | Github account access token |
| repository | Repository to comment on |
| pullRequest | Pull request number to add the comment to |
| comment | Comment text |
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});
| Parameter | Description |
|---|---|
| account | Github account username |
| token | Github account access token |
| repository | Repository to retrieve comments from |
| pullRequest | Pull request number to read comments from |
The example response can be found HERE.
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});
| Parameter | Description |
|---|---|
| account | Github account username |
| token | Github account access token |
| repository | Repository to update comment on |
| commentId | Id of the comment to be updated |
| updatedComment | Text which the comment will be updated to |
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});
| Parameter | Description |
|---|---|
| account | Github account username |
| token | Github account access token |
| repository | Repository to remove comment from |
| commentId | Id of the comment to be removed |
Please see the contribution document for further details.
FAQs
Github commenting made easy
We found that github-comment-manager demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.