Set variables with YAML

YAML parameters for Set variables

Name Type Description
action Required String The name of the action.
type Required String The type of the action. Should be set to SET_VARIABLES.
variables Required Variable[] The list of existing settable variables.
key Required String The name of the variable.
defaults String The value of the variable.
encrypted Boolean Encrypted values will not be visible once saved. Can be used for things like passwords.
init_path String Path to the file with options.
comment String The custom comment that will be displayed upon passing arguments.
permissions PipelinePermissions Define to set permissions for the action.

YAML example for Set variables

yaml
actions: - action: "Set Variables" type: "SET_VARIABLES" comment: "comment" variables: - key: "var1" type: "VAR" - key: "var2" type: "VAR" defaults: "option1\noption2" - key: "var3" type: "VAR" init_path: "/fileWithOptions" - key: "var4" type: "VAR"

PipelinePermissions schema

Name Type Description
others String AccessLevel for the group Others. Can be one of DENIED, ALLOWED. Default setting is ALLOWED.
users UserPermission[] The list of users who will be granted a permission other than the Others group.
groups GroupPermission[] The group who will be granted a permission other than the Others group.
yaml
permissions: others: "DENIED" users: alex@buddy.works: "DENIED" mike@buddy.works: "ALLOWED" groups: frontend: "DENIED" backend: "ALLOWED"

Last modified on Mar 4, 2025