YAML for Custom Action

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

YAML parameters for Custom Action

PARAMETERS

custom_typerequiredstring

The custom action to run, as <name>:<tag>: name from a definition in .buddy/actions/<directory>/action.yml of a workspace project, tag a Git tag of that repository or latest for the default branch, e.g. deploy_tool:latest.

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

Values of the inputs declared in the custom action definition, keyed by input name. An undeclared input is rejected and every required input must be set.

trigger_timestring enum

Specifies when the action should be executed.

Allowed enum:

ON_EVERY_EXECUTION,

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

When true, the action runs only on the first failure instead of on each failure. Used only when 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. It cannot exceed the action time limit of the workspace plan; a higher value is rejected.

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.

Constraints: ≤ 10

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 Nov 2, 2026

Cursor 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: "deploy_tool:latest"
  variables_access: true
  filesystem_access: true
  inputs:
    MESSAGE: "Deploying $BUDDY_RUN_COMMIT"
    API_KEY: "$DEPLOY_API_KEY"
    ENV: "prod"