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

YAML for Approve Visual Tests

View as Markdown

Approve visual test results for a pipeline action.

YAML parameters for Approve Visual Tests

PARAMETERS
from_actionrequiredstring
The ID of the action from which visual test results are retrieved
suiterequiredstring
The name of the visual test suite to approve
typerequiredstring

Value: APPROVE_VT

actionrequiredstring
Unique identifier for the action within the pipeline.
refstring
The git reference (branch, tag, or commit) for which to approve visual test results
permissionsPermissionsYaml
Access permissions for the action.
commentstring
Comment to add when approving/rejecting.
descriptionstring
Description or message shown to approvers.
prevent_self_approvalboolean
If set to true, the approver must be different from the person who triggered the run. Default: false.
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 pageAmazon S3Next pageAtop

YAML examples for Approve Visual Tests

Approve Visual Tests

yaml
  - action: "Approve Visual Tests"
    type: "APPROVE_VT"
    from_action: "Run Visual Tests"
    suite: "regression-suite"
    ref: "$BUDDY_EXECUTION_REVISION"

Approve Visual Tests with permissions

yaml
  - action: "Approve Visual Tests"
    type: "APPROVE_VT"
    from_action: "Run Visual Tests"
    suite: "regression-suite"
    ref: "$BUDDY_EXECUTION_REVISION"
    permissions:
      others: "DENIED"
      users:
        alex@buddy.works: "DENIED"
        mike@buddy.works: "ALLOWED"
      groups:
        frontend: "DENIED"
        backend: "ALLOWED"