Skip to content

Commit

Permalink
Document inputs (#9)
Browse files Browse the repository at this point in the history
Intentionally omitting `initial-delay` as about to be removed in favour
of awaiting > 0 non-ignored jobs as a startup strategy. GitHub has been
observed in the past to take >1min to spawn job requests when it is
experiencing issues (aka nearly every day).
  • Loading branch information
ben-challis authored Apr 26, 2024
1 parent 0bd428d commit 3a9cba7
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,14 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
```
## Inputs
| Name | Description | Required | Default |
|----------|----------------------------------------------------------------------------------------------------------------------------------------|----------|-------------------------------------------------------------|
| token | GitHub token to use to interact with the GitHub API, unless you have rate limit concerns this should be `${{ secrets.GITHUB_TOKEN }}`. | Yes | |
| ref | Git reference to checkout. The default supports Pull Requests, Merge Queues as well as branch pushes. | No | `${{ github.event.pull_request.head.sha \|\| github.sha }}` |
| interval | The number of seconds in between polls of the GitHub API for check run conclusions. | No | `5` |
| timeout | The number of seconds before the job is declared a failure if check runs have not yet concluded. | No | `300` |
| name | The name of the Sloth's own check run. This is used to ensure Sloth does not wait upon itself. | No | `"sloth"` |
| ignored | A comma separated list of check run names to ignore when determining an overall result. | No | `""` |

0 comments on commit 3a9cba7

Please sign in to comment.