Docker CLI with YAML

YAML Parameters for Docker CLI

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Must be set to NATIVE_BUILD_DOCKER_CLI.
working_directory
Required
StringThe directory in which the pipeline filesystem will be mounted.
commands
Required
String[]The commands that will be executed.
execute_every_commandBooleanIf set to true all commands will be executed regardless of the result of the previous command.
sync_pathsSyncPath[]Define file paths that should be copied before (PIPELINE_TO_VM) and after the execution (VM_TO_PIPELINE).
docker_layer_cachingBooleanEnables or disables Docker layer caching.
docker_layer_caching_scopeBooleanRequired if docker_layer_caching is set to true. Defines the caching scope. Available values: WORKSPACE, PROJECT, PIPELINE, ACTION.
docker_layer_caching_tagStringDefines the name of the tag assigned to the cached layer.

YAML example for Docker CLI

actions:
- action: "Execute: docker --version"
  type: "NATIVE_BUILD_DOCKER_CLI"
  working_directory: "/home/ubuntu/build"
  commands:
  - "docker --version"
  variables:
  - key: "env"
    value: "dev"
    type: "VAR"
  sync_paths:
  - pipeline_path: "/"
    vm_path: "/home/ubuntu/build"
    direction: "PIPELINE_TO_VM"
    excludes: "/.git"
  - pipeline_path: "/"
    vm_path: "/home/ubuntu/build"
    direction: "VM_TO_PIPELINE"
    excludes: ""