Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for ZIP

View as Markdown

ZIP (ZIP)

YAML parameters for ZIP

PARAMETERS
local_pathrequiredstring
The local path to the files to compress
destinationrequiredstring
The destination path for the ZIP archive
typerequiredstring

Value: ZIP

actionrequiredstring
Unique identifier for the action within the pipeline.
deployment_excludesstring[]
The list of file patterns to exclude from the ZIP archive
deployment_includesstring[]
The list of file patterns to include in the ZIP archive
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 Apr 27, 2026

Previous pageXcodeNext pageYAML for targets

YAML examples for ZIP

Create ZIP archive with filters

yaml
  - action: "Zippy zip"
    type: "ZIP"
    trigger_time: "ON_EVERY_EXECUTION"
    local_path: "/dir_to_zip"
    destination: "artifact.zip"
    deployment_excludes:
      - "/assets/"
      - "file.txt"
    deployment_includes:
      - "/assets/assets-new/"
      - "/assets/file.txt"

Simple ZIP archive

yaml
  - action: "Create archive"
    type: "ZIP"
    local_path: "/build"
    destination: "build.zip"