From f75b3c75cef6ebd9facc5ff666c67580dc4c578d Mon Sep 17 00:00:00 2001 From: Gaurav Chaudhari Date: Mon, 12 Oct 2020 20:18:16 +0530 Subject: [PATCH] Add arguments table (#194) --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 31e52d18..41065704 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,31 @@ Run the tests :heavy_check_mark: ```bash $ npm test ``` +### Arguments + +| Input | Description | Usage | +| :---: | :---: | :---: | +| `repo-token` | PAT(Personal Access Token) for authorizing repository. | *Required* | +| `days-before-stale` | Idle number of days before marking an issue/pr as stale. *Defaults to **60*** | Optional +| `days-before-close` | Idle number of days before closing an stale issue/pr. *Defaults to **7*** | Optional +| `stale-issue-message` | Message to post on the stale issue. | Optional +| `stale-pr-message` | Message to post on the stale pr. | Optional +| `close-issue-message` | Message to post on the stale issue while closing it. | Optional +| `close-pr-message` | Message to post on the stale pr while closing it. | Optional +| `stale-issue-label` | Label to apply on the stale issue. *Defaults to **stale*** | Optional +| `close-issue-label` | Label to apply on closing issue. | Optional +| `stale-pr-label` | Label to apply on the stale pr. | Optional +| `close-pr-label` | Label to apply on the closing pr. | Optional +| `exempt-issue-labels` | Labels on an issue exempted from being marked as stale. | Optional +| `exempt-pr-labels` | Labels on the pr exempted from being marked as stale. | Optional +| `only-labels` | Only labels checked for stale issue/pr. | Optional +| `operations-per-run` | Maximum number of operations per run. *Defaults to **30*** | Optional +| `remove-stale-when-updated` | Remove stale label from issue/pr on updates or comments. *Defaults to **true*** | Optional +| `debug-only` | Dry-run on action. *Defaults to **false*** | Optional +| `ascending` | Order to get issues/pr. *Defaults to **false*** | Optional +| `skip-stale-issue-message` | Skip adding stale message on stale issue. *Defaults to **false*** | Optional +| `skip-stale-pr-message` | Skip adding stale message on stale pr. *Defaults to **false*** | Optional + ### Usage