Pass arguments with YAML

YAML parameters for Pass arguments

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to WAIT_FOR_VARIABLES.
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.
permissionsPipelinePermissionsDefine to set permissions for the action.

YAML example for Pass parameters

actions:
- action: "Pass arguments"
  type: "WAIT_FOR_VARIABLES"
  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: "param1"    
    defaults: "option1\noption2\noption3"

PipelinePermissions schema

NameTypeDescription
othersStringAccessLevel for the group Others. Can be one of DENIED, ALLOWED. Default setting is ALLOWED.
usersUserPermission[]The list of users who will be granted a permission other than the Others group.
groupsGroupPermission[]The group who will be granted a permission other than the Others group.
  permissions:
    others: "DENIED"
    users:
      alex@buddy.works: "DENIED"
      mike@buddy.works: "ALLOWED"
    groups:
      frontend: "DENIED"
      backend: "ALLOWED"

Last modified on July 5, 2023

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.