Skip to content

Add typed JSON output to theme publish - #8652

Merged
gonzaloriestra merged 5 commits into
gonzalo/theme-telemetry-guardfrom
gonzalo/json-theme-publish
Oct 15, 2026
Merged

gonzaloriestra merged 5 commits into
gonzalo/theme-telemetry-guardfrom
gonzalo/json-theme-publish

Conversation

@gonzaloriestra

@gonzaloriestra gonzaloriestra commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

Theme publishing needs a typed automation result.

WHAT is this pull request doing?

Add strict JSON mutation resources with string IDs, nullable source URLs and status/changed outcomes. Preserve cancellation and every explicit environment result.

The public output follows docs/cli/json-output.md; explicitly named environments use one {environments: [...]} object.

How to manually test your changes?

shopify theme publish --theme <theme-id> --store example.myshopify.com --json
shopify theme publish --json-schema

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

@gonzaloriestra
gonzaloriestra added this pull request to stack #8654 September 24, 2026 09:47
@github-actions github-actions Bot added Area: @shopify/cli @shopify/cli package issues shopify.dev preview labels Sep 24, 2026
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from d3213d0 to 789a14a Compare September 24, 2026 10:04
@gonzaloriestra
gonzaloriestra removed this pull request from stack #8654 September 24, 2026 10:04
@gonzaloriestra
gonzaloriestra added this pull request to stack #8655 September 24, 2026 10:05
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 789a14a to bcdcb7d Compare September 24, 2026 10:13
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from bcdcb7d to 56a75f3 Compare September 24, 2026 10:25
@github-actions github-actions Bot added no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. and removed Area: @shopify/cli @shopify/cli package issues labels Sep 24, 2026
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 56a75f3 to 15a4930 Compare September 24, 2026 11:56
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch 2 times, most recently from 0adfd99 to 5ba599e Compare September 24, 2026 14:21
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review September 24, 2026 14:34
@gonzaloriestra
gonzaloriestra requested review from a team as code owners September 24, 2026 14:34
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 5ba599e to 51ec362 Compare September 24, 2026 14:36
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 51ec362 to 46ed754 Compare September 25, 2026 12:28
@gonzaloriestra
gonzaloriestra removed this pull request from stack #8655 September 25, 2026 12:28
@gonzaloriestra
gonzaloriestra added this pull request to stack #8673 September 25, 2026 12:29
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 46ed754 to f8d5e61 Compare September 28, 2026 08:20
@gonzaloriestra
gonzaloriestra marked this pull request as draft October 6, 2026 12:18
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 065a1ec to 2c531be Compare October 6, 2026 12:29
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 2c531be to 1523653 Compare October 6, 2026 12:31
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 1523653 to d3b8376 Compare October 6, 2026 13:53
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from d3b8376 to 3644e3d Compare October 8, 2026 08:43
@gonzaloriestra gonzaloriestra reopened this Oct 8, 2026
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 3644e3d to 8aefc17 Compare October 8, 2026 09:53
@gonzaloriestra
gonzaloriestra marked this pull request as ready for review October 8, 2026 10:04
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 8aefc17 to ff6543b Compare October 9, 2026 12:00
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from ff6543b to 572dd63 Compare October 9, 2026 12:26
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 572dd63 to 9fd693d Compare October 9, 2026 12:48
@gonzaloriestra
gonzaloriestra force-pushed the gonzalo/json-theme-publish branch from 9fd693d to 04c1a78 Compare October 9, 2026 13:09

@karreiro karreiro 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.

Thank you, @gonzaloriestra!

@github-actions

Copy link
Copy Markdown
Contributor

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/base-command.d.ts
@@ -35,6 +35,7 @@ declare abstract class BaseCommand extends Command {
         argv: string[];
     }>;
     protected environmentsFilename(): string | undefined;
+    protected validateNonTTYFlags(flags: FlagOutput): void;
     protected failMissingNonTTYFlags(flags: FlagOutput, requiredFlags: string[]): void;
     private failMissingNonTTYFlagRequirements;
     private applicableNonTTYFlagRequirements;

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

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants