Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/no-carrier.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Cardenas <cevaris@gmail.com>2015-05-29 21:53:18 +0300
committerChris Rebert <code@rebertia.com>2015-06-04 12:22:15 +0300
commit859b4c94bfea97ed4166061a279032da2652cb1c (patch)
treec2f1d03dc2c1b106b7cd762e512d8d6d797656a4 /README.md
parent084b3470f2f40ba66daced041d4cbe8a16f89693 (diff)
Load GitHub credentials from environment variables.
Fixes #6 Closes #8 by merging a tweaked version of it.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8cb32fa..830a5a7 100644
--- a/README.md
+++ b/README.md
@@ -23,9 +23,11 @@ By automating the process of closing abandoned issues, the issue tracker is kept
## Usage
Java 8+ is required to run NO CARRIER. For instructions on building NO CARRIER yourself, see [the Contributing docs](https://github.com/twbs/no-carrier/blob/master/CONTRIBUTING.md).
-NO CARRIER accepts exactly 5 command line arguments. Once you've built the JAR, run e.g. `java -jar no-carrier-assembly-1.0.jar <username> <password> <owner/repo> <label> <days>`. Here's what each of the arguments is:
-* `username`: Username of GitHub user to login as
-* `password`: Password of GitHub user to login as
+NO CARRIER requires 2 environment variables to be set:
+* `$GITHUB_USERNAME` - Username of GitHub user for NO CARRIER to login as
+* `$GITHUB_PASSWORD` - Password of GitHub user for NO CARRIER to login as
+
+NO CARRIER accepts exactly 3 command line arguments. Once you've built the JAR, run e.g. `java -jar no-carrier-assembly-1.0.jar <owner/repo> <label> <days>`. Here's what each of the arguments is:
* `owner/repo`: GitHub repo whose issues will be operated upon (example: `twbs/bootstrap` for [Bootstrap](https://github.com/twbs/bootstrap))
* `label`: Name of label used on the repo's GitHub issue tracker to indicate that the issue is blocked waiting for a reply from a user (typically the issue's original poster).
* `days`: Integer number of days. If at least this number of days elapses after an issue has been labeled without any new comment being posted, NO CARRIER will close the issue and post an explanatory comment.