From a28d6a25096efb9c8acea3e8d26e7f7f50dfd6b5 Mon Sep 17 00:00:00 2001 From: joe fleming Date: Thu, 18 Oct 2018 16:35:21 -0700 Subject: [PATCH] docs: update readme, add sample env --- README.md | 12 +++++++++--- sample-env | 6 ++++++ 2 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 sample-env diff --git a/README.md b/README.md index 56aca08..a5061ad 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/sample-env b/sample-env new file mode 100644 index 0000000..39826d2 --- /dev/null +++ b/sample-env @@ -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