Pass arguments with YAML

YAML parameters for Pass arguments

NameTypeDescription
name
Required		StringThe name of the action.
trigger_time
Required		StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
variables
Required		Variable[]The list of variables to set as parameters for the pipeline. At least one parameter is required.
key
Required		StringThe name of the parameter.
defaultsStringThe value of the parameter.
encryptedBooleanEncrypted values will not be visible once saved. Can be used for things like passwords.
init_pathStringPath to the file with options.
commentStringThe custom comment that will be displayed upon passing arguments.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS.
trigger_condition_pathsString[]Required when trigger_condition is set to ON_CHANGE_AT_PATH.
trigger_variable_keyStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the name of the desired variable.
trigger_variable_valueStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the value of the desired variable which will be compared with its current value.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.

YAML example for Pass parameters

actions:
  - action: "Wait for apply"
    type: "WAIT_FOR_APPLY"
    trigger_time: "ON_EVERY_EXECUTION"
    comment: "Version should be like X.Y.Z"
    variables:
    - key: "key1"
      encrypted: true
      defaults: "param1"
    - key: "key2"
      defaults: "param2"
    - key: "key3"
      init_path: "file"
    - key: "key4"
      defaults: "param3"
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.