If condition are always evaluated as true when containing expression syntax inside

[dlavrenuek]

Describe the bug
An if condition in a step definition that includes expression syntax in condition body is always evaluated as false positive or is ignored.

Example workflow: https://github.com/dlavrenuek/test-workflow-if-condition/blob/master/.github/workflows/test.yml

name: test if conditions

on:
  push:
    branches: [master, test]

env:
  TEST_BRANCH: "test"
  EMPTY_VALUE: ""

jobs:
  test-conditions:
    runs-on: ubuntu-latest

    steps:
      - name: simple evaluation on master
        if: github.ref == 'refs/heads/master'
        run: echo "runs"

      - name: simple evaluation on test
        if: github.ref == 'refs/heads/test'
        run: echo "runs"

      - name: false positive with expression syntac evaluation
        if: github.ref == 'refs/head/${{ env.TEST_BRANCH }}' # this condition is ignored or is evaluated as false positive
        run: echo "runs"

      - name: false positive with expression syntac evaluation
        if: false && '${{ env.EMPTY_VALUE }}' # this condition is ignored or is evaluated as false positive
        run: echo "runs"

Example run: https://github.com/dlavrenuek/test-workflow-if-condition/runs/2914408827?check_suite_focus=true

Example step definition:

      - name: false positive with expression syntax evaluation
        if: github.ref == 'refs/head/${{ env.TEST_BRANCH }}'
        run: echo "runs"

In the example workflow the last two steps should not have been run, but they were

To Reproduce
Steps to reproduce the behavior:

1. create a workflow
2. add an if condition with expression syntax ${{ ... }} as part of the condition (not wrapping the whole condition)
3. trigger the workflow

Expected behavior

• The if condition should be correctly evaluated.
• In case that the expression syntax is not supported as part of an if condition - an error should be thrown instead of silently ignoring it.

Runner Version and Platform

GitHub platform

What's not working?

The steps are executed because of false positive evaluation of he if condition containing expression syntax

[TingluoHuang]

@dlavrenuek you can enable debug log to see how the expression gets evaluated.
https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging#enabling-step-debug-logging

[dlavrenuek]

@TingluoHuang Here are the logs for the step:

      - name: false positive with expression syntax evaluation
        if: github.ref == 'refs/head/${{ env.TEST_BRANCH }}' # is always executed
        run: echo "runs"

##[debug]Evaluating condition for step: 'false positive with expression syntax evaluation'
##[debug]Evaluating: (success() && format('github.ref == ''refs/head/{0}''', env.TEST_BRANCH))
##[debug]Evaluating And:
##[debug]..Evaluating success:
##[debug]..=> true
##[debug]..Evaluating format:
##[debug]....Evaluating String:
##[debug]....=> 'github.ref == ''refs/head/{0}'''
##[debug]....Evaluating Index:
##[debug]......Evaluating env:
##[debug]......=> Object
##[debug]......Evaluating String:
##[debug]......=> 'TEST_BRANCH'
##[debug]....=> 'test'
##[debug]..=> 'github.ref == ''refs/head/test'''
##[debug]=> 'github.ref == ''refs/head/test'''
##[debug]Expanded: (true && 'github.ref == ''refs/head/test''')
##[debug]Result: 'github.ref == ''refs/head/test'''
##[debug]Starting: false positive with expression syntax evaluation
...

[dlavrenuek]

And logs for

      - name: false positive with expression syntax evaluation
        if: false && '${{ env.EMPTY_VALUE }}' # is always executed
        run: echo "runs"

##[debug]Evaluating condition for step: 'false positive with expression syntax evaluation'
##[debug]Evaluating: (success() && format('false && ''{0}''', env.EMPTY_VALUE))
##[debug]Evaluating And:
##[debug]..Evaluating success:
##[debug]..=> true
##[debug]..Evaluating format:
##[debug]....Evaluating String:
##[debug]....=> 'false && ''{0}'''
##[debug]....Evaluating Index:
##[debug]......Evaluating env:
##[debug]......=> Object
##[debug]......Evaluating String:
##[debug]......=> 'EMPTY_VALUE'
##[debug]....=> ''
##[debug]..=> 'false && '''''
##[debug]=> 'false && '''''
##[debug]Expanded: (true && 'false && ''''')
##[debug]Result: 'false && '''''
##[debug]Starting: false positive with expression syntax evaluation

[rgr]

any solution?

[dvishniakov]

@TingluoHuang , can you please remove the awaiting-customer-responselabel? Response with debug output was provided.

[dvishniakov]

I've opened a #1395 with a similar result, but the syntax is if: ( ${{ expression}} ). Seems like logical grouping brackets around expression confuses the engine.

[eb-mikegorecki]

Bump

[gsingh1]

I ran into this issue recently too and the way I got expressions to work in if correctly was to use the format function. Please try this:

      - name: false positive with expression syntax evaluation
        if: github.ref == format('refs/heads/{0}', env.TEST_BRANCH)
        run: echo "::error::This step should be skipped and not run!" && false

[fenollp]

        if: false && '${{ env.EMPTY_VALUE }}' # is always executed

The string '${{ env.EMPTY_VALUE }}' is truthy so this expression evaluates to true. See my other comment: #1395 (comment)

[prashil-g]

+1

[GabrieleCalarota]

+1 How can we solve this?

[ThePieMonster]

Having the same issue with the if statement check as shown below. Always returns true...

- run: |
    if [[ ${{ env.TAGCHECK }} == "true" ]] ; then echo "Hello!" ; else echo "Goodbye!" ; fi
    if [[ "${{ env.TAGCHECK }}" == "true" ]] ; then echo "Hello!" ; else echo "Goodbye!" ; fi
    if [[ ${{ env.TAGCHECK }} == "false" ]] ; then echo "Hello!" ; else echo "Goodbye!" ; fi
    if [[ "${{ env.TAGCHECK }}" == "false" ]] ; then echo "Hello!" ; else echo "Goodbye!" ; fi

- name: Create Tag
  if: ${{ env.TAGCHECK }} == "false"
  uses: actions/github-script@v5
  with:
    script: |
       code...
      })

[BuckinghamIO]

How can this still be an issue almost a year on? Kinda disappointed really as this is quite a fundamental part.

[raghuvarmabh]

After spending lot of time understanding this i achieved what i want by comparing with the string values of true false from within the run command instead of if:.

[WoodyWoodsta]

Honestly losing faith in actions - they're just not stable and powerful enough to run organisation-level workflows.

[raghuvarmabh]

I fixed like this

[joshghent]

I had the same issue
if: ${{ inputs.environment }} == 'prod'

Really don't get it. I am in the process of moving from Azure DevOps but this is a blocker.

[dlavrenuek]

@joshghent this should work in your case:

if: inputs.environment == 'prod'

[kimberleyhallifax]

I'm encountering the same issue, this always evaluates to true

if: ${{ env.FILE_CHANGED }} != "0"

And this is syntactically incorrect so I can't use it:

if: env.FILE_CHANGED != "0"

[unlikelyzero]

What year is it?

[thejeff77]

Just needs to be fixed in the documentation... it says all over to use the ${{ }} syntax which is invalid for if statements.

[Sohaib112]

I am having the same issue.
the value of app_found is false in the previous step but it still runs terraform init.

- name: Terraform init
  if: steps.check.outputs.app_found == 'true'
  run: |
    cd ${{ steps.changed-apps.outputs.path }}
    terraform init -upgrade

Here is the debug log:

##[debug]Evaluating condition for step: 'Terraform init'
##[debug]Evaluating: (success() && (steps.check.outputs.app_found == 'true'))
##[debug]Evaluating And:
##[debug]..Evaluating success:
##[debug]..=> true
##[debug]..Evaluating Equal:
##[debug]....Evaluating Index:
##[debug]......Evaluating Index:
##[debug]........Evaluating Index:
##[debug]..........Evaluating steps:
##[debug]..........=> Object
##[debug]..........Evaluating String:
##[debug]..........=> 'check'
##[debug]........=> Object
##[debug]........Evaluating String:
##[debug]........=> 'outputs'
##[debug]......=> Object
##[debug]......Evaluating String:
##[debug]......=> 'app_found'
##[debug]....=> null
##[debug]....Evaluating String:
##[debug]....=> 'true'
##[debug]..=> false
##[debug]=> false
##[debug]Expanded: (true && (null == 'true'))
##[debug]Result: false

I have tried adding ${{ steps.check.outputs.app_found }} == 'true' But still not worked.
Debug logs for this:

##[debug]Evaluating condition for step: 'Terraform init'
##[debug]Evaluating: (success() && format('({0} == ''true'')', steps.check.outputs.app_found))
##[debug]Evaluating And:
##[debug]..Evaluating success:
##[debug]..=> true
##[debug]..Evaluating format:
##[debug]....Evaluating String:
##[debug]....=> '({0} == ''true'')'
##[debug]....Evaluating Index:
##[debug]......Evaluating Index:
##[debug]........Evaluating Index:
##[debug]..........Evaluating steps:
##[debug]..........=> Object
##[debug]..........Evaluating String:
##[debug]..........=> 'check'
##[debug]........=> Object
##[debug]........Evaluating String:
##[debug]........=> 'outputs'
##[debug]......=> Object
##[debug]......Evaluating String:
##[debug]......=> 'app_found'
##[debug]....=> null
##[debug]..=> '( == ''true'')'
##[debug]=> '( == ''true'')'
##[debug]Expanded: (true && '( == ''true'')')
##[debug]Result: '( == ''true'')'

[ViniciusBastosTR]

This issue will be fixed?

[AivazNurgaliev]

@benoit-cty Sir, I am forever grateful for your help! I had been sitting 5 hours on this problem, but your reply really helped. Thank you!

[tking16]

Github actions suuucks

[cceaaal]

I changed the syntax in the condition from e.g.

if: ${{steps.step_id.outputs.output_var}} == 'string'

to

if: ${{steps.step_id.outputs.output_var == 'string'}}

that seems to work

[raksbi]

Wow, it is kinda amazing that, this basic thing does not work as expected.

[FreyGeospatial]

I changed the syntax in the condition from e.g.

if: ${{steps.step_id.outputs.output_var}} == 'string'

to

if: ${{steps.step_id.outputs.output_var == 'string'}}

that seems to work

Confirming this works. Also found some documentation that may be helpful, regarding the ${{ ... }} syntax for if evaluations:
https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idif

[ryan-williams]

This GHA shows the result of various string comparisons in if: predicates, using inputs empty (set to '') and nonempty (set to 'nonempty'):

Whole predicate wrapped in ${{ … }}, or no ${{ … }} ⇒ OK ✅

${{ … }} wrapping half of comparison ⇒ false positives ❌