Skip to content

fix: quote Action metadata descriptions - #38

Merged
efegokdemir merged 1 commit into
mainfrom
efe/action-metadata-yaml
Oct 30, 2026
Merged

efegokdemir merged 1 commit into
mainfrom
efe/action-metadata-yaml

Conversation

@efegokdemir

Copy link
Copy Markdown
Member

Summary

Quote the action.yml descriptions that contain commas and a colon so the Action manifest parses correctly.

Motivation

After correcting Dependabot's GitHub Actions directory to /, the update job began reading the root action.yml and failed because the api-version-status description was not valid YAML. The format description also needs quoting to remain one string in the parsed input metadata.

Changes

Quote the format and api-version-status descriptions. Input and output names, defaults, runtime and behaviour are unchanged.

Tests performed

Passed: strict YAML parsing and input/output metadata checks, npm run action:check, npm run package:smoke, and git diff --check.

Compatibility

No input/output names, defaults, Action runtime, or report behaviour changed. The format description now lists the supported values accurately.

Security and privacy

No workflow permissions, triggers, credentials, or data handling changed.

Shopify source/evidence

N/A.

Release impact

This fixes the repository Action manifest. The package version remains 0.4.0; no tag or npm publish is part of this PR.

Checklist

  • The change is focused and the docs/examples match the implementation.
  • Relevant checks are recorded above.
  • No generated distribution needs updating for metadata-only changes.
  • No sensitive or unlicensed third-party material was added.

@efegokdemir
efegokdemir merged commit bb301d8 into main Oct 30, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant