Skip to content

fix: resolve YAML syntax error in update-docs workflow and add actionlint#173

Merged
jeremyeder merged 2 commits intoambient-code:mainfrom
jeremyeder:fix/update-docs-yaml-syntax
Dec 5, 2025
Merged

fix: resolve YAML syntax error in update-docs workflow and add actionlint#173
jeremyeder merged 2 commits intoambient-code:mainfrom
jeremyeder:fix/update-docs-yaml-syntax

Conversation

@jeremyeder
Copy link
Copy Markdown
Contributor

Summary

  • Fixed YAML syntax error in .github/workflows/update-docs.yml on line 43
  • Added actionlint to pre-commit hooks for local workflow validation
  • Fixed shellcheck warnings in workflow shell script

Changes

Workflow Syntax Fix

Replaced template literal syntax with array concatenation to avoid YAML parsing issues:

  • Before: Used ${variable} inside multi-line template literal
  • After: Build body using array and .join('\n') method

Shell Script Improvements

Added proper quoting around $GITHUB_OUTPUT variable to satisfy shellcheck.

Pre-commit Enhancement

Added actionlint hook to .pre-commit-config.yaml to catch workflow issues locally before push.

Testing

pre-commit run actionlint --files .github/workflows/update-docs.yml
# ✓ Passed

Why This Matters

GitHub Actions YAML parser can be sensitive to nested template literals with special characters. The error was triggered by the ${revisionReason} interpolation inside a backtick-quoted string within the YAML script: | block.

The actionlint addition prevents future workflow syntax issues from reaching CI.


🤖 Generated with Claude Code

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant