29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# gh-action-bot
|
|
|
|
Action bot for Github. Checks a repo's event stream and leaves a ghost comment when your criteria is met.
|
|
|
|
[](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
|
|
[](https://nodejs.org/api/documentation.html#documentation_stability_index)
|
|
|
|
## Usage
|
|
|
|
`yarn start owner/repo`: watch the event stream and handle matches
|
|
|
|
`yarn run force owner/repo pr_number`: force a comment on a specific pr, by number
|
|
|
|
`yarn run clean owner/repo pr_number`: removed any comments that match the owner and body requirements
|
|
|
|
You'll need to set some environment flags. Check `sample-env` for what is available, and you can copy the file to `.env` in the root and add your settings there as well.
|
|
|
|
### Personal Access Token
|
|
|
|
You will need to provide a Github [Personal Access Token](https://github.com/settings/tokens/new). It will need `write:org` access in order to create comments.
|
|
|
|
### Debugging
|
|
|
|
If the script isn't doing what you expect, you can get more output from it by prepending the script with `DEBUG=1`.
|
|
|
|
#### License
|
|
|
|
MIT © [w33ble](https://github.com/w33ble)
|