Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions .agents/skills/authoring-github-workflows/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
name: authoring-github-workflows
Comment thread
YuliiaKovalova marked this conversation as resolved.
description: "Author and review GitHub Actions workflow YAML safely so syntactically-valid YAML can't ship a workflow that GitHub Actions refuses to run. USE FOR: editing, adding, or reviewing any file under .github/workflows/, writing run-name/name/if/env/run values that contain ${{ }} expressions, diagnosing a run that fails with 'This run likely failed because of a workflow file issue' and no jobs starting, deciding when a workflow scalar must be quoted, validating workflows with actionlint. DO NOT USE FOR: authoring application YAML unrelated to GitHub Actions, Azure Pipelines, GitLab CI, or non-workflow YAML. INVOKES: actionlint (downloaded pinned binary) plus git/grep for inspection."
license: MIT
---

# Authoring GitHub Actions Workflows Safely

GitHub Actions workflow files are YAML, but **valid YAML is not the same as a valid workflow**. A workflow can parse cleanly with `yaml.safe_load` (or a casual review) yet still be rejected by GitHub Actions at load time — producing the opaque failure *"This run likely failed because of a workflow file issue"* with **zero jobs started**. This skill teaches the YAML-vs-Actions traps (the `#`-as-comment trap above all), how to quote expression scalars correctly, and how to validate with `actionlint` before merge.

## When to Use

- Editing, adding, or reviewing any file under `.github/workflows/`.
- Writing a `run-name`, `name`, `if`, `env`, `with`, or `run` value that embeds a `${{ }}` expression.
- A workflow run failed with *"This run likely failed because of a workflow file issue"* and **no jobs ran**.
- Eval/CI on `main` suddenly breaks for every run after a workflow edit merged, even though the change "looked fine."
- Deciding whether a YAML scalar needs quoting.

## When Not to Use

- Authoring non-Actions YAML (app config, Kubernetes, Compose, Azure Pipelines, GitLab CI).
- Pure shell/script logic inside an already-valid `run:` block (that is a scripting task, not a workflow-syntax task).

## The #1 Trap: `#` inside an unquoted expression becomes a YAML comment

In YAML, a space followed by `#` starts a **comment**. In an unquoted (plain) scalar, everything from that space-then-`#` to end-of-line is silently discarded:

```yaml
# BAD — the run-name is silently truncated at " #"
run-name: ${{ inputs.pr_number != '' && format('Evaluate PR #{0} @ {1}', inputs.pr_number, inputs.head_sha) || '' }}
```

YAML parses this as `run-name: ${{ inputs.pr_number != '' && format('Evaluate PR` — an **unterminated `${{` expression**. `yaml.safe_load` succeeds (it just sees a truncated string with a trailing comment), so the bug passes naive validation, but GitHub Actions rejects the malformed expression and refuses to start any run.

```yaml
# GOOD — wrap the whole value in double quotes so '#' stays inside the scalar
run-name: "${{ inputs.pr_number != '' && format('Evaluate PR #{0} @ {1}', inputs.pr_number, inputs.head_sha) || '' }}"
```

The inner expression already uses single quotes, so double-quoting the scalar is safe. This is exactly the bug that broke `dotnet/skills` evaluation on `main` (PR #746 → fixed by quoting).

## Other characters that force quoting in a plain scalar

| Character / pattern | Why it breaks | Fix |
|---------------------|---------------|-----|
| space then `#` (space-hash) | Starts a YAML comment; truncates the value | Quote the whole value |
| Leading `*`, `&`, `!`, `?`, `\|`, `>`, `@`, `` ` `` | YAML anchors/aliases/tags/block scalars | Quote the value |
| Leading `{` or `[` | Parsed as flow mapping/sequence (a bare `${{ }}` starts with `$`, which is safe, but `{{` after a leading char is risky) | Quote the value |
| `:` then space (colon-space) inside the value | Parsed as a nested mapping key | Quote the value |
| Leading/trailing spaces that matter | Plain scalars strip them | Quote the value |
| Values that are `true`/`false`/`yes`/`no`/`on`/`off`/numbers but must stay strings | YAML type coercion | Quote the value |

**Rule of thumb:** if a `name`, `run-name`, `if`, `env`, or `with` value contains a `${{ }}` expression *and* any literal `#`, `:`, or leading special character, **wrap the entire scalar in double quotes**.

## Workflow

### Step 1: Identify the changed/authored workflow files

```bash
git diff --name-only origin/main... -- .github/workflows/
```

For each file, scan every line that contains `${{` together with a `#`, a colon-space, or a leading special character.

### Step 2: Quote risky expression scalars

Wrap the full value in double quotes when the value embeds an expression and contains a `#` or other special character (see the table above). Prefer double quotes when the inner expression uses single quotes, and vice-versa. Do **not** escape the `${{ }}` braces — quoting the scalar is enough.

### Step 3: Validate with actionlint (authoritative)

`actionlint` understands the GitHub Actions schema *and* the expression grammar, so it catches exactly this class of bug that plain YAML linters miss. Download a pinned release and run it:

```bash
ACTIONLINT_VERSION=1.7.7
curl -sSLo actionlint.tar.gz \
"https://github.com/rhysd/actionlint/releases/download/v${ACTIONLINT_VERSION}/actionlint_${ACTIONLINT_VERSION}_linux_amd64.tar.gz"
tar -xzf actionlint.tar.gz actionlint
Comment thread
YuliiaKovalova marked this conversation as resolved.
Outdated
# Focus on workflow/expression correctness; silence shell/py style noise:
./actionlint -shellcheck= -pyflakes= -color .github/workflows/*.yml
```

On Windows PowerShell, use the `actionlint_<ver>_windows_amd64.zip` asset and `Expand-Archive`.

The truncated-expression bug surfaces as:

```
got unexpected EOF while lexing end of string literal, expecting ''' [expression]
```

A clean exit code `0` means the workflows are structurally valid.

### Step 4: Confirm a YAML-only check is not enough

Do **not** rely on `yaml.safe_load`, `yamllint`, or "it parses" as proof. They accept the truncated-comment form. Only `actionlint` (or pushing and watching GitHub Actions parse it) validates the Actions layer.

### Step 5: Keep the CI gate green

This repository runs `actionlint` automatically (see `.github/workflows/actionlint.yml`) on any PR that touches `.github/workflows/`. Ensure your change passes that check before requesting review. If you add a new workflow, the gate covers it automatically.

## Validation

- [ ] Every `${{ }}` value containing `#`, a colon-space, or a leading special character is wrapped in quotes.
- [ ] `actionlint -shellcheck= -pyflakes= .github/workflows/*.yml` exits `0`.
- [ ] No workflow run reports *"This run likely failed because of a workflow file issue"*.
- [ ] The `actionlint` CI check is green on the PR.

## Common Pitfalls

| Pitfall | Solution |
|---------|----------|
| Unquoted `run-name`/`name` with `#` inside the expression | Wrap the whole value in double quotes |
| Trusting `yaml.safe_load`/`yamllint`/a code review to catch it | Run `actionlint`; YAML-only checks accept the truncated form |
| Escaping `${{` braces to "fix" it | Don't — quote the scalar instead; escaping breaks the expression |
| Using single quotes around a value that contains single quotes | Use double quotes for the outer scalar |
| Adding `actionlint` with shellcheck enabled and drowning in pre-existing shell-style warnings | Run with `-shellcheck= -pyflakes=` to focus on workflow/expression errors |
| Assuming a green YAML lint means the workflow will run | Push and confirm jobs actually start, or rely on the actionlint gate |

## References

- [actionlint](https://github.com/rhysd/actionlint) — static checker for GitHub Actions workflows.
- [GitHub Actions: workflow syntax](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions)
- [YAML 1.2 spec — comments](https://yaml.org/spec/1.2.2/#66-comments)
- Repository skill-authoring guide: [`.agents/skills/create-skill/SKILL.md`](../create-skill/SKILL.md)
8 changes: 8 additions & 0 deletions .github/actionlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# actionlint configuration. See: https://github.com/rhysd/actionlint/blob/main/docs/config.md
# Declares custom/self-hosted runner labels used by this repository so actionlint
# does not flag them as unknown. Keep in sync with the labels referenced by
# `runs-on:` across .github/workflows/.
self-hosted-runner:
labels:
- ubuntu-slim
- windows-11-arm
62 changes: 62 additions & 0 deletions .github/workflows/actionlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: actionlint

# Validates GitHub Actions workflow files with actionlint, which understands the
# Actions schema and expression grammar. This catches bugs that plain YAML linters
# miss — most notably an unquoted `${{ }}` expression containing `#`, where YAML
# treats ` #` as a comment and silently truncates the expression, producing a file
# that parses as YAML but that GitHub Actions refuses to run.
# See: .agents/skills/authoring-github-workflows/SKILL.md

on:
pull_request:
paths:
- ".github/workflows/**"
- ".github/actions/**"
push:
branches: [main]
paths:
- ".github/workflows/**"
- ".github/actions/**"
workflow_dispatch:
Comment thread
YuliiaKovalova marked this conversation as resolved.

permissions:
contents: read

jobs:
actionlint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

Comment thread
YuliiaKovalova marked this conversation as resolved.
- name: Run actionlint
env:
ACTIONLINT_VERSION: "1.7.7"
run: |
set -euo pipefail
curl -sSLo actionlint.tar.gz \
"https://github.com/rhysd/actionlint/releases/download/v${ACTIONLINT_VERSION}/actionlint_${ACTIONLINT_VERSION}_linux_amd64.tar.gz"
tar -xzf actionlint.tar.gz actionlint
Comment thread
YuliiaKovalova marked this conversation as resolved.
Outdated
Comment thread
YuliiaKovalova marked this conversation as resolved.

# Lint only hand-authored workflows. Files generated by gh-aw
# (`*.lock.yml` and others) carry a "DO NOT EDIT" header and are
# excluded — they are compiled artifacts, not source we maintain.
to_lint=()
while IFS= read -r f; do
if head -n 30 "$f" | grep -qiE 'DO NOT EDIT|automatically generated|gh aw'; then
echo "skip (generated): $f"
else
to_lint+=("$f")
fi
done < <(find .github/workflows -type f \( -name '*.yml' -o -name '*.yaml' \) | sort)

if [ "${#to_lint[@]}" -eq 0 ]; then
echo "No hand-authored workflows to lint."
exit 0
fi

printf 'Linting:\n'; printf ' %s\n' "${to_lint[@]}"
# Focus on workflow + expression correctness. shellcheck/pyflakes are
# disabled to avoid failing on pre-existing shell/Python style warnings;
# the goal of this gate is to block workflows GitHub Actions cannot run.
./actionlint -shellcheck= -pyflakes= -color "${to_lint[@]}"
2 changes: 1 addition & 1 deletion .github/workflows/evaluation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ name: evaluation
# head_sha is the default branch — not the PR head — so the run name is how the
# worker recognises that an evaluation has already been dispatched for this head.
# For all other events the expression yields '' and GitHub uses the default name.
run-name: ${{ inputs.pr_number != '' && format('Evaluate PR #{0} @ {1}', inputs.pr_number, inputs.head_sha) || '' }}
run-name: "${{ inputs.pr_number != '' && format('Evaluate PR #{0} @ {1}', inputs.pr_number, inputs.head_sha) || '' }}"

on:
# Manual trigger for one-off deploys (e.g., AGENTVIZ SPA update) and
Expand Down
Loading