w33ble/gh-action-bot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: update readme, add sample env

Browse Source
This commit is contained in:
joe fleming
2018-10-18 16:35:21 -07:00
parent ced41f4a49
commit a28d6a2509
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,10 +1,16 @@
# gh-action-bot
Action bot for Github.
Action bot for Github. Checks a repo's event stream and leaves a ghost comment when your criteria is met.
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
[![npm](https://img.shields.io/npm/v/gh-action-bot.svg)](https://www.npmjs.com/package/gh-action-bot)
[![Project Status](https://img.shields.io/badge/status-experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
[![Project Status](https://img.shields.io/badge/status-stable-green.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
## Usage
`node . owner/repo`
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.
#### License

6
sample-env Normal file
View File

@@ -0,0 +1,6 @@
GITHUB_ACCESS_TOKEN=xxx
COMMENT_ACTOR=ci-comment-username
COMMENT_BODY_REGEXP=build failed
COMMENT_BODY_REGEXP_FLAGS=i
PULL_LABEL_FILTER=
PULL_RETEST_BODY=retest