Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add random wait strategy on retry #139

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/inspectionProfiles/Project_Default.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions .idea/php.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/retry.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ Retries an Action step on failure or timeout. This is currently intended to repl

**Optional** Number of seconds to wait before attempting the next retry. Defaults to `10`

### `retry_wait_strategy`

**Optional** Strategy to use for retry wait. Currently supports [fixed (default), random].

### `retry_wait_seconds_min`

**Optional** Min. number of seconds to wait before attempting the next retry when using random strategy. Defaults to `5`. Used only when `retry_wait_strategy` is set to `random`.

### `retry_wait_seconds_max`

**Optional** Max. number of seconds to wait before attempting the next retry when using random strategy. Defaults to `5` Used only when `retry_wait_strategy` is set to `random`.

### `shell`

**Optional** Shell to use to execute `command`. Defaults to `powershell` on Windows, `bash` otherwise. Supports bash, python, pwsh, sh, cmd, and powershell per [docs](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell)
Expand Down Expand Up @@ -74,6 +86,16 @@ The final exit code returned by the command

The final error returned by the command

## Wait strategies

### Fixed

Default strategy. Waits for `retry_wait_seconds` between retries.

### Random

Waits for a random number of seconds between `retry_wait_seconds_min` and `retry_wait_seconds_max` between retries.

## Examples

### Shell
Expand Down
12 changes: 12 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ inputs:
description: Number of seconds to wait before attempting the next retry
required: false
default: 10
retry_wait_seconds_min:
description: Number of seconds to min. wait before attempting the next retry - used for random wait strategy
required: false
default: 5
retry_wait_seconds_max:
description: Number of seconds to max wait before attempting the next retry - used for random wait strategy
required: false
default: 10
retry_wait_strategy:
description: Strategy to use for retry wait. Supports fixed and random
required: false
default: fixed
shell:
description: Alternate shell to use (defaults to powershell on windows, bash otherwise). Supports bash, python, pwsh, sh, cmd, and powershell
required: false
Expand Down
Loading