Skip to content

Add typed JSON output to app deploy - #8816

Open
isaacroldan wants to merge 17 commits into
codex/json-success-diagnosticsfrom
codex/json-app-deploy
Open

isaacroldan wants to merge 17 commits into
codex/json-success-diagnosticsfrom
codex/json-app-deploy

Conversation

@isaacroldan

@isaacroldan isaacroldan commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Let scripts read deployment outcomes. Related to #23668.

WHAT is this pull request doing?

Add --json output for the app, created version, and release state. A declined confirmation returns cancelled. A failed release retains the created version as partial and exits nonzero. Transport failures use the shared fatal error document because the remote release state is unknown.

Treat a null release response as a failed release. Text output then reports New version created, but not released. No additional API request is made.

Text: New version created.

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

Depends on #8857 for shared success diagnostics. This PR's diff and changeset cover app deploy only.

How to manually test your changes?

Use a disposable linked app.

  1. Run shopify app deploy --path <app> --no-release --version json-review --json --no-input > deploy.json 2> events.jsonl. Check one result with the created version and released: false.
  2. Repeat without --json, using --version text-review. Check the existing message and release instructions.
  3. Use a missing app path with --json --no-input --no-release. Expect one error object and a nonzero exit. Run shopify app deploy --json-schema to inspect the contract.

Validation

134 focused deploy tests, 19 JSON lint-rule tests, and 10 postrun tests passed. Scoped lint, app/CLI type checks and builds, Knip, and generated command checks passed. Compiled CLI probes passed for schema discovery and the missing-path error. Deployment calls were stubbed; no remote app was deployed.

Checklist

  • I've considered possible cross-platform impacts
  • I've considered documentation changes
  • I've considered analytics changes
  • Added the required changeset

@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 79a623bffddc50f165fbbef1f67460bffdca4422. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007114720

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 7, 2026

Copy link
Copy Markdown
Contributor

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

Built from 6b5fb70fa30aab28531cca1654f2b8cd414a06e8. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007121118

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-deploy branch from 4683822 to ed70d5d Compare October 7, 2026 13:32
@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 ed70d5d1d302896f7ca3257d440b8fa99e594503. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007133853

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 7, 2026

Copy link
Copy Markdown
Contributor

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

Built from 5a62644e14dbdcb01ab5e2dbc3e3c2d6ae439050. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261007140351

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-deploy branch from 5a62644 to b9b9dad Compare October 8, 2026 16:05
@isaacroldan
isaacroldan changed the base branch from main to qlaw/json-i23668-app-build October 8, 2026 16:05
@isaacroldan
isaacroldan marked this pull request as ready for review October 8, 2026 16:07
@isaacroldan
isaacroldan requested review from a team as code owners October 8, 2026 16:07
@isaacroldan
isaacroldan added this pull request to stack #8813 October 8, 2026 16:07
@isaacroldan
isaacroldan removed this pull request from stack #8813 October 8, 2026 16:13
@isaacroldan
isaacroldan added this pull request to stack #8837 October 8, 2026 16:13
@isaacroldan
isaacroldan removed this pull request from stack #8837 October 8, 2026 16:15
@isaacroldan
isaacroldan changed the base branch from qlaw/json-i23668-app-build to main October 8, 2026 16:15
@isaacroldan
isaacroldan changed the base branch from main to qlaw/json-i23668-app-build October 8, 2026 16:15
@isaacroldan
isaacroldan force-pushed the codex/json-app-deploy branch from 85020cb to b4c2608 Compare October 8, 2026 16:16
@isaacroldan
isaacroldan added this pull request to stack #8838 October 8, 2026 16:17
@isaacroldan
isaacroldan force-pushed the codex/json-app-deploy branch from b4c2608 to dfc107b Compare October 9, 2026 08:15
@isaacroldan
isaacroldan removed this pull request from stack #8838 October 9, 2026 08:16
@isaacroldan
isaacroldan changed the base branch from qlaw/json-i23668-app-build to codex/json-upgrade-output October 9, 2026 08:17
@isaacroldan
isaacroldan added this pull request to stack #8846 October 9, 2026 08:17
@isaacroldan
isaacroldan removed this pull request from stack #8846 October 9, 2026 08:19
@isaacroldan
isaacroldan removed this pull request from stack #8847 October 9, 2026 09:07
@isaacroldan
isaacroldan changed the base branch from codex/json-upgrade-output to main October 9, 2026 09:20
@isaacroldan
isaacroldan force-pushed the codex/json-app-deploy branch from 9c22cec to f3b58aa Compare October 9, 2026 09:20
@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 b59ef04a6e56e6db3601112dabb097f52c8618fb. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261009105838

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 changed the base branch from main to codex/json-success-diagnostics October 9, 2026 16:10
@isaacroldan
isaacroldan added this pull request to stack #8858 October 9, 2026 16:11
@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 24dbee4bb6f524c608e48a176938380de86183aa. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261009161200

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 fe9f6dbfd4e00c83e3176db7f6b5205153d8764e. Workflow run.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261009172349

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.

This branch has not been deployed

No deployments
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.

2 participants