Skip to main content

Custom condition always evaluates to false if `finished` step-status is used

  • Updated

Symptoms

A custom step condition using finished step-status always evaluates to false

Cause

The finished step-status is an alias that includes success, failure or skipped step-statuses. But it's valid only when it's used on Step Dependencies, for example:

second_step:
  title: Second step
  when:
    steps:
     - name: first_step
       on:
         - finished

Refs.:

  • https://codefresh.io/docs/docs/codefresh-yaml/advanced-workflows/#single-step-dependencies
  • https://codefresh.io/docs/docs/codefresh-yaml/advanced-workflows/#multiple-step-dependencies

It's not a valid step-status if used in a custom-condition (link). For example, this condition won't work:

my_step:
  ...
  when:
    condition:
      any:
        condition_a: steps.step_1.result == 'finished'  # this will always be false
        condition_b: ${{MY_VAR}} == 'VALUE'

Solution

Since the finished alias is just available for step-dependencies|conditions, then you can workaround this by specifying the possible step-status of the step you're interested in, applying a logical OR (||) in the custom-condition.

For example, following the same example above, this would be the solution:

my_step:
  ...
  when:
    condition:
      any:
        condition_a: steps.step_1.result == 'success' || steps.step_1.result == 'failure'
        condition_b: ${{MY_VAR}} == 'VALUE'

Read more

You can find more information about this topic in the following links:

Related articles