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

YAML for Compress images

View as Markdown

Compress images to reduce file size while maintaining quality.

YAML parameters for Compress images

PARAMETERS
local_pathrequiredstring
The path in the repository.
destinationrequiredstring
Output directory for compressed images.
levelrequiredstring
The level of image compression. Can be set to 1 (low), 2 (medium) or 3 (high).
typesrequiredstring
Supported image formats. Available types: jpg, png, gif, svg.
typerequiredstring

Value: IMAGE_COMPRESSION

actionrequiredstring
Unique identifier for the action within the pipeline.
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 pageCodeDeployNext pageContentful CLI

YAML examples for Compress images

Compress images with options

yaml
  - action: "Compress images"
    type: "IMAGE_COMPRESSION"
    local_path: "assets/"
    destination: "compressed_images/"
    level: "2"
    types: "jpg,png,gif,svg"