Cloudflare with YAML

YAML parameters for Cloudflare

NameTypeDescription
zone_id
Required
StringThe ID of the Cloudflare zone.
distribution_name
Required
StringThe name of the Cloudflare web distribution.
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to CLOUDFLARE.
integration_id
Required
IntegerThe ID of the integration.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
run_only_on_first_failureBooleanDefines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
base_urlStringThe URL address to the desired site.
purge_allBooleanSpecifies whether or not the whole cache should be removed.
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.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS.
trigger_condition_pathsString[]Required when trigger_condition is set to ON_CHANGE_AT_PATH.
trigger_variable_keyStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the name of the desired variable.
trigger_variable_valueStringRequired when trigger_condition is set to VAR_IS, VAR_IS_NOT or VAR_CONTAINS. Defines the value of the desired variable which will be compared with its current value.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.

YAML Example for Cloudflare

actions:
- action: "Cloudflare action"
type: "CLOUDFLARE"
input_type: "SCM_REPOSITORY"
local_path: "/"
zone_id: "f00e1e106ca13e658477bf7393ad83f1"
distribution_name: "buddy.works"
purge_all: false
base_url: "https://buddy.works",
integration_id: 2
deployment_excludes:
- "/tmp"
- "*.log"
deployment_includes:
- "/tmp/assets"
- "/tmp/styles"