Skip to content

Fixed broken GitHub release note creation#1471

Merged
carterworks merged 1 commit intomainfrom
fix-broken-github-release-notes
Apr 2, 2026
Merged

Fixed broken GitHub release note creation#1471
carterworks merged 1 commit intomainfrom
fix-broken-github-release-notes

Conversation

@carterworks
Copy link
Copy Markdown
Collaborator

@carterworks carterworks commented Mar 24, 2026

Description

The ghReleaseCreate function in scripts/createGithubReleases.js was using execSync with string concatenation to build a shell command, which caused release notes containing special characters (quotes, newlines, etc.) to break the gh release create command. This switches to execFileSync, which passes arguments as an array directly to the process, bypassing shell interpretation entirely.

Related Issue

N/A

Motivation and Context

GitHub release notes were failing to be created when the notes contained characters that are special to the shell. Using execFileSync avoids shell escaping issues and is also more secure (no command injection risk).

Screenshots (if appropriate):

Example of broken release notes from https://github.com/adobe/alloy/releases

image

Checklist:

  • I have signed the Adobe Open Source CLA or I'm an Adobe employee.
  • I have made any necessary test changes and all tests pass.
  • I have run the Sandbox successfully.
  • I have added a Changeset (pnpm changeset) or it is not necessary because this PR is not consumer-facing.

@carterworks carterworks added the ignore-for-release Do not include this PR in release notes label Mar 24, 2026
@carterworks carterworks self-assigned this Mar 24, 2026
@carterworks carterworks added the ignore-for-release Do not include this PR in release notes label Mar 24, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 24, 2026

⚠️ No Changeset found

Latest commit: 2fec6f2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@carterworks carterworks merged commit 3ba5e78 into main Apr 2, 2026
7 of 8 checks passed
@carterworks carterworks deleted the fix-broken-github-release-notes branch April 2, 2026 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ignore-for-release Do not include this PR in release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants