Skip to content
Esc

github-actions-expression-syntax

A workflow never holds a malformed ${{, which fails the whole workflow before any job runs.

GitHub parses every ${{ ... }} in a workflow file before it schedules a job. One bad opener makes the workflow invalid: it fails in zero seconds with no job logs, and any required check it was meant to report stays pending. Two slips cause nearly all of it. A script or f-string that writes a literal ${{{name}}} (the opener is followed by another brace), and an expression whose closing }} was lost in an edit.

A ${{ immediately followed by another {, and a ${{ with no closing }}. A scalar that wraps over several lines (a folded or literal block, or a plain or quoted scalar with deeper continuation lines) is read as one unit, so an expression may close on a later line of the same scalar but not past its end. A second ${{ before the first one closes is also reported, at the first opener. A ${{ inside a YAML comment is checked like any other text, because GitHub lexes it too.

# Bad
- run: python -c "print(f'${{{name}}}')"
if: ${{ github.ref == 'refs/heads/main'
# Good
- run: python -c "print(f'$' + '{{' + name + '}}')"
if: ${{ github.event_name == 'push' }}
if: >-
${{ github.event_name == 'push' &&
github.ref == 'refs/heads/main' }}
  • Grammar errors inside a closed expression (an unknown function, a bad operator): a workflow linter such as actionlint covers those.
  • An expression that spans lines inside a block or multi-line scalar and closes before the scalar ends.
  • A '}}' or '${{' inside a single-quoted string within an expression: it is string text, and '' is an escaped quote.

Line-based text, not a YAML parse. A key: &anchor header absorbs its deeper child lines into one unit, so an unclosed opener there can be closed by a }} on a nested line.

createGithubActionsExpressionSyntaxRule(options?: GithubActionsExpressionSyntaxOptions): IMetaRule
Option Type Default Meaning
workflowGlobs string[] ['.github/workflows/*.yml', '.github/workflows/*.yaml'] Workflow files to scan.
ciCritical boolean true Whether a violation fails CI.

If your workflows are generated and validated by a tool that already rejects malformed expressions before they are committed, this adds nothing.