Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for Copy files

View as Markdown

Copy files (COPY_FILES)

YAML parameters for Copy files

PARAMETERS
typerequiredstring

Value: COPY_FILES

actionrequiredstring
Unique identifier for the action within the pipeline.
source_projectstring
The project containing the source pipeline from which files will be copied. If not set, uses the current project
source_pipelinestring
The source pipeline from which files will be copied. If not set, uses the current pipeline
target_projectstring
The project containing the target pipeline to which files will be copied. If not set, uses the current project
target_pipelinestring
The target pipeline to which files will be copied. If not set, uses the current pipeline
source_pathstring
The path in the source pipeline's filesystem
target_pathstring
The path in the current pipeline's filesystem
deployment_excludesstring[]
The paths and/or files that will be left out during the deployment
deployment_includesstring[]
The exceptions from the ignore patterns set in deployment_excludes
copy_hidden_filesboolean
When set to true the hidden files and folders (the ones with the name beginning with a ".") are copied
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Jul 31, 2025

Previous pageContentful CLINext pageCrawl

YAML examples for Copy files

Copy files between pipelines

yaml
  - action: "Copy files from backend/dev"
    type: "COPY_FILES"
    copy_hidden_files: true
    trigger_time: "ON_EVERY_EXECUTION"
    source_project: "backend"
    source_pipeline: "dev"
    target_project: "backend"
    target_pipeline: "stage"
    source_path: "/src"
    target_path: "/www"
    deployment_excludes:
      - "/tmp"
      - "*.log"
    deployment_includes:
      - "/tmp/assets"
      - "/tmp/styles"

Simple file copy

yaml
  - action: "Copy build artifacts"
    type: "COPY_FILES"
    source_project: "api"
    source_pipeline: "build"
    target_project: "api"
    target_pipeline: "deploy"