Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesTerraformTunnelsYAMLBuddy GitCLIAPIFAQ

YAML for EXTRACT

View as Markdown

Extract archive (EXTRACT)

YAML parameters for EXTRACT

PARAMETERS
source_pathrequiredstring
The path to the archive to extract. Supported formats: zip, tar, tar.gz, tar.bz2, tar.xz, 7z, gz, bz2, xz
typerequiredstring

Value: EXTRACT

actionrequiredstring
Unique identifier for the action within the pipeline.
destination_pathstring
The directory to extract the archive into. By default, the directory containing the archive
passwordstring
The password for an encrypted archive
delete_sourceboolean
Set to true to delete the archive after it has been successfully extracted. By default, it's set to false
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
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
When true, the action runs only on the first failure instead of on each failure. Used only when 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. It cannot exceed the action time limit of the workspace plan; a higher value is rejected.
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.

Constraints: ≤ 10

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 Nov 2, 2026

Previous pageEmail notificationNext pageFirebase

YAML examples for EXTRACT

Extract password-protected archive and remove it

yaml
- action: "Extract archive"
  type: "EXTRACT"
  trigger_time: "ON_EVERY_EXECUTION"
  source_path: "artifacts/app.zip"
  destination_path: "dist/"
  password: "$ARCHIVE_PASSWORD"
  delete_source: true

Extract archive next to the source file

yaml
- action: "Extract archive"
  type: "EXTRACT"
  source_path: "artifacts/app.zip"