Skip to content

with.timeout · Execution timeout

Configure the maximum duration a step is allowed to run.

yaml
- _: Say hi
  log: Bonjour, mes amis !
  with:
    timeout:
      attempts: 5 minutes
      global: 15 minutes
    retry:
      attempts: 3

TIP

Use Infinity to let a step run indefinitely.

with.timeout.attempts

The timeout for each individual attempt, after which the current attempt will be aborted. It is intended to be used in conjunction with with.retry.attempts to limit the duration of each attempt.

When a step has no retry policy, this property behaves like with.timeout.global.

This property is evaluated on each retry attempt, which makes it possible to create dynamic timeouts values.

yaml
- with:
    timeout:
      attempts: ${3 * esquie.result.attempts} minutes

TIP

Using timeout: <value> with a duration value is a shorthand for timeout: { attempts: <value> }.

yaml
- with:
    timeout: 5 minutes

with.timeout.global

The overall timeout for the step, after which the entire step (including all attempts, delays AND children steps) will be aborted.

Released under the MIT License.