YAML for Custom Action

View as Markdown

Execute a custom action from the Buddy Marketplace or private registry.

YAML parameters for Custom Action

PARAMETERS

custom_typerequiredstring

Custom action type identifier (e.g., organization/action-name:tag).

typerequiredstring

Value: CUSTOM

actionrequiredstring

Unique identifier for the action within the pipeline.

variables_accessboolean

When true, the action has access to pipeline variables.

filesystem_accessboolean

When true, the action has access to the repository filesystem.

inputsobject

Input values for the custom action as key-value pairs.

trigger_timestring enum

Specifies when the action should be executed.

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

loopstring[]

The list of variables for dynamic action execution. The action runs once for each value.

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.

disabledboolean

When set to true the action is disabled. By default it is set to false.

timeoutinteger

The timeout in seconds.

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.

retry_intervalinteger

Delay time between auto retries in seconds.

retry_countinteger

Number of retries if the action fails.

run_nextstring enum

Defines whether the action should run in parallel with the next one.

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

trigger_conditionsTriggerConditionYaml[]

The list of trigger conditions to meet so that the action can be triggered.

variablesVariableYaml[]

The list of variables you can use in the action.

Last modified on Jul 31, 2025

Create new sandbox Custom Build

YAML examples for Custom Action

Custom action with inputs

yaml
  - action: "Run custom action"
    type: "CUSTOM"
    trigger_time: "ON_EVERY_EXECUTION"
    custom_type: "my-custom-action:1.0"
    variables_access: true
    filesystem_access: true
    inputs:
      input1: "value1"
      input2: "value2"