Ruby CommandsTrigger

Ruby CommandsTrigger

Certified

Trigger a flow when Ruby commands match a condition

Polls and triggers a flow by executing inline Ruby scripts and commands.

yaml
type: io.kestra.plugin.scripts.ruby.CommandsTrigger

Trigger when Ruby command fails.

yaml
id: ruby_commands_trigger
namespace: company.team

triggers:
  - id: on_fail
    type: io.kestra.plugin.scripts.ruby.CommandsTrigger
    interval: PT5S
    exitCondition: "exit 1"
    commands:
      - ruby -e "raise 'boom'"

tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "Triggered with exitCode={{ trigger.exitCode }}"
Properties
SubTypestring

Ruby commands to execute

Commands executed on each poll.

Condition to match

Condition evaluated after execution.

Supported forms:

  • 'exit N'
  • regex / substring matched against vars + logs
Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

Defaultruby

Docker image used to execute the commands

Container image used by the underlying Commands task to run Ruby commands. Defaults to 'ruby'.

Defaulttrue

Edge trigger mode

If true, the trigger emits only on a transition from 'not matching' to 'matching' (anti-spam). If false, the trigger emits on every poll where the condition matches.

DefaultPT1M
Formatduration

Check interval

Interval between polling evaluations.

SubTypestring
Possible Values
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Rendered condition

Rendered value of the exitCondition property for this poll.

Commands exit code

Exit code returned by the Ruby process (may be null if not available).

Formatdate-time

Poll timestamp

Timestamp when this trigger evaluation occurred.

Commands vars

Vars produced by the task (e.g. via ::{"outputs": {...}}:: convention).

More Plugins in this Category

Core Plugins and tasks
Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

Core

109 tasks

580 blueprints

Lua
Lua

Tasks that run Lua scripts.

Core

2 tasks