Skip to content

Add typed JSON output to app release - #8820

Merged
isaacroldan merged 12 commits into
mainfrom
codex/json-app-release
Oct 14, 2026
Merged

isaacroldan merged 12 commits into
mainfrom
codex/json-app-release

Conversation

@isaacroldan

@isaacroldan isaacroldan commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Let scripts read app release outcomes. Related to #23668.

WHAT is this pull request doing?

Add --json with validated release data and shared fatal errors. Declined confirmation returns {"status":"cancelled"} and exits zero. Keep the existing text banners, including the missing-version headline and styled version tag. Reject missing release confirmation and retain API user errors.

Text: Version released to users. with a v1 link.

{"status":"success","app":{"name":"Example","clientId":"client-id"},"release":{"version":{"gid":"gid://shopify/Version/123","name":"v1","message":null,"url":"https://dev.shopify.com/dashboard/1/apps/1/versions/123"}}}

How to manually test your changes?

Use a disposable test app with an existing version.

  1. Run shopify app release --version <version> --allow-updates --allow-deletes --json --no-input > result.json 2> events.jsonl. Check one release result and stderr progress. Repeat without --json to compare the existing banner.
  2. Run with an unknown version, with and without --json. Expect the same missing-version message and a nonzero exit; JSON mode returns one error object. In a terminal, omit the allow flags and decline confirmation; expect one cancelled result and exit zero.
  3. Run shopify app release --json-schema to inspect the contract.

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

@github-actions github-actions Bot added shopify.dev preview Area: @shopify/cli @shopify/cli package issues labels Oct 7, 2026
@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from fc26ec9000f3ecb159bbb01b9dfe03f1cb8d8da3. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan
isaacroldan force-pushed the codex/json-app-release branch from 59f5ccc to f1732c7 Compare October 7, 2026 13:33
@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

The snapshot requested by @isaacroldan for f1732c7ed41b529fbc4a7b61acd9188e63fe3f22 could not be published. View the workflow run.

@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 9c0de556d23c8e7e04e32a48d95d60fd330c2b6d. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan
isaacroldan force-pushed the codex/json-app-release branch from 9c0de55 to 126d935 Compare October 8, 2026 16:03
@isaacroldan
isaacroldan marked this pull request as ready for review October 8, 2026 16:05
@isaacroldan
isaacroldan requested review from a team as code owners October 8, 2026 16:05
@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 126d935b0070b68b0aa666f0c2d259531546c243. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 7ccc6a0ca241f4adb999374844dd6385fb2190dd. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 8f5bc823f30dac2ef5da3a31049abe85cc744da4. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

dmerand
dmerand previously requested changes Oct 9, 2026

@dmerand dmerand left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small change request.

@isaacroldan
isaacroldan enabled auto-merge October 13, 2026 10:07
@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from d754374d59a4fc90450d9435c5ac2749598918b2. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@gonzaloriestra

Copy link
Copy Markdown
Contributor

/snapit

@github-actions

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @gonzaloriestra! Your snapshot has been published to npm.

Built from 89030bb20567ea8cf48e4f18909b185a13183950. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Built from 44c7751cf6a93f906cad12f6e5812640718f3d01. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/[email protected]

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@isaacroldan
isaacroldan dismissed dmerand’s stale review October 14, 2026 10:33

Comment addressed, PR approved by Gonzalo

@isaacroldan
isaacroldan added this pull request to the merge queue Oct 14, 2026
Merged via the queue into main with commit 87e0417 Oct 14, 2026
28 of 31 checks passed
@isaacroldan
isaacroldan deleted the codex/json-app-release branch October 14, 2026 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/cli @shopify/cli package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants