Skip to content

Commit

Permalink
docs: add doc for debug-only option
Browse files Browse the repository at this point in the history
  • Loading branch information
C0ZEN committed May 23, 2021
1 parent 0a64514 commit 55a76e1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Every argument is optional.
| [remove-stale-when-updated](#remove-stale-when-updated) | Remove stale label from issue/PR on updates or comments. | `true` |
| [remove-issue-stale-when-updated](#remove-issue-stale-when-updated) | Remove stale label from issue on updates or comments. | |
| [remove-pr-stale-when-updated](#remove-pr-stale-when-updated) | Remove stale label from PR on updates or comments. | |
| [debug-only](#debug-only) | Dry-run on action.<br>_Defaults to **false**_. | |
| [debug-only](#debug-only) | Dry-run on action. | `false` |
| [ascending](#ascending) | Order to get issues/PR.<br>`true` is ascending, `false` is descending.<br>_Defaults to **false**_. | |
| [skip-stale-issue-message](#skip-stale-issue-message) | Skip adding stale message on stale issue.<br>_Defaults to **false**_. | |
| [skip-stale-pr-message](#skip-stale-pr-message) | Skip adding stale message on stale PR.<br>_Defaults to **false**_. | |
Expand Down Expand Up @@ -279,6 +279,14 @@ Override [remove-stale-when-updated](#remove-stale-when-updated) but only to aut

Default value: unset

#### debug-only

Run the stale workflow as dry-run.
No GitHub API calls that can alter your issues and pull requests will happen.
Useful to debug or when you want to configure the stale workflow safely.

Default value: `false`

#### exempt-milestones

A white-list of milestone(s) to only process the issues or the pull requests that does not contain one of these milestone(s).
Expand Down

0 comments on commit 55a76e1

Please sign in to comment.