buddy.yml file defines all pipelines in the project. Every pipeline consists of a list of actions to be executed. Below you’ll find schemas for both pipelines and actions.
The file consists of a list of pipelines:
- pipeline: "production"trigger_mode: "MANUAL"ref_name: "master"variables:- key: "username"value: "Buddy"settable: falsedescription: "var_descrption"- pipeline: "build"trigger_mode: "ON_EVERY_PUSH"ref_name: "*"
|pipeline ||String||The ID of the pipeline.|
|trigger_mode ||String||The trigger mode of the pipeline. Can be one of |
|ref_type||String||The ref type that triggers the pipeline. Can be one of |
|ref_name||String||The wildcard, branch, tag or pull request. Automatically set to NONE if not provided.|
|always_from_scratch||Boolean||Defines whether or not to upload everything from scratch on every execution.|
|auto_clear_cache||Boolean||Defines whether or not to automatically clear cache before running the pipeline .|
|no_skip_to_most_recent||Boolean||Defines whether or not to skip execution to the most recent execution.|
|do_not_create_commit_status||Boolean||Defines whether or not to omit sending commit statuses to Github or Gitlab upon execution.|
|start_date||iso 8601 utc date||Required if the pipeline is set to |
|delay||Integer||Required if the pipeline is set to |
|cron||String||Required if the pipeline is set to |
|actions_list||String||The list of actions executed in the pipeline.|
|variables||Variable||The list of variables you can use in the pipeline.|
|ignore_fail_on_project_status||Boolean||If set to |
|execution_message_template||String||The title of every execution in this pipeline. By default it is set to |
Every pipeline contains a list of actions. The actions are executed in the order provided in the
- pipeline: "production"trigger_mode: "MANUAL"ref_name: "master"ref_type: "BRANCH"execution_message_template: "test"ignore_fail_on_project_status: "true"actions:- action: "Execute: npm test"type: "BUILD"docker_image_name: "library/node"docker_image_tag: "6"execute_commands:- "npm install"- "npm test"setup_commands:- "npm install -g gulp grunt-cli"variables:- key: "username"value: "Buddy"settable: truedescription: "var_description"- action: "Upload files to buddy.server"type: "FTP"input_type: "BUILD_ARTIFACTS"local_path: "/"login: "buddy"password: "password"host: "buddy.server"port: "21"
|action ||String||The ID of the action.|
|type ||String||The type of the action.|
|trigger_time||String||Specifies when the action should be executed. Can be one of |
|variables||Variable||The list of variables you can use the action.|
|trigger_condition||String||Defines when the build action should be run. Can be one of |
|trigger_condition_paths||String||Required when |
|trigger_variable_key||String||Required when |
|trigger_variable_value||String||Required when |
|timeout||Integer||The timeout in seconds.|
|disabled||Boolean||When set to |
|run_next_parallel||Boolean||When set to |
|run_only_on_first_failure||Boolean||Defines whether the action should be executed on each failure. Restricted to and required if the |
On top of these three properties every action has a set properties unique to its type. You can read how to define each type in separate articles.