Update multi-environment theme command behaviour #6124

dejmedus · 2025-07-17T00:30:43Z

WHY are these changes introduced?

Previously multi-environment theme commands required force = "true" to be set in shopify.theme.toml since multi env commands must run without interactions. This PR allows flags to be provided via the CLI and adds a confirmation prompt that will run prior to concurrent command calls.

WHAT is this pull request doing?

Accepts command flags from both shopify.theme.toml and the CLI, with CLI flags taking precedence.
Prompts for confirmation before running commands if the command accepts force (ex. delete, push, pull) and --force has not been set.
Catches/handles command errors in renderConcurrent to prefix environment name to the error message and ensure that subsequent environment's commands will still be called.

multi-environment-demo.mov

How to test your changes?

pull down the branch gh checkout 6124
add a shopify.theme.toml file

Example toml

[environments.store1]
theme = "<theme>"
store = "<store>"
password  = "<shptka_password>"

[environments.store2]
theme = "<theme>"
store = "<store>"
password  = "<shptka_password>"

[environments.missing]
theme = "<theme>"
store = "<store>"

[environments.fake]
theme = "1000000"
store = "fake.myshopify.com"
password  = "not-real"

info and list commands both currently work with multiple envs
since neither allow --force (and confirmation prompts arent shown on commands that dont accept --force) the force flag can be manually added to test confirmation prompt

// packages/theme/src/cli/commands/theme/list.ts

force: Flags.boolean({
  char: 'f',
  description: 'Skip confirmation',
  env: 'SHOPIFY_FLAG_FORCE',
}),

pnpm shopify theme list -e store1 -e store2 -e missing -e fake

environments missing flags should display a warning and the command shouldn't be executed
environments with incorrect flags (ex. password = "fake") should have the environment name prefixed to the error message. Commands should fail gracefully and not prevent commands from running in other environments.
commands run with a single environment or no environment should work as normal

Post-release steps

more commands will be updated to allow multiple environments
multi-env documentation

Measuring impact

How do we know this change was effective? Please choose one:

Existing analytics will cater for this addition

Checklist

I've considered possible cross-platform impacts (Mac, Linux, Windows)
I've considered possible documentation changes

github-actions · 2025-07-17T18:46:22Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	78.1% (+0.12% 🔼)	13053/16713
🟡	Branches	72.17% (+0.08% 🔼)	6354/8804
🟡	Functions	78.19% (+0.06% 🔼)	3380/4323
🟡	Lines	78.5% (+0.12% 🔼)	12361/15746

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / local-storage.ts	100%	54.55% (-4.55% 🔻)	100%	100%
🔴	`...` / theme-store.ts	0% (-80% 🔻)	0% (-75% 🔻)	0% (-100% 🔻)	0% (-80% 🔻)

Test suite run success

3052 tests passing in 1315 suites.

Report generated by 🧪jest coverage report action from b382a89

dejmedus · 2025-07-17T20:22:28Z

/snapit

github-actions · 2025-07-17T20:25:26Z

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

Test the snapshot by installing your package globally:

pnpm i -g @shopify/[email protected]

Tip

If you get an ETARGET error, install it with NPM and the flag --@shopify:registry=https://registry.npmjs.org

Caution

After installing, validate the version by running just shopify 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.

dejmedus · 2025-07-17T22:09:12Z

packages/theme/src/cli/utilities/theme-command.ts

@@ -41,6 +47,7 @@ export default abstract class ThemeCommand extends Command {
  async command(
    _flags: FlagValues,
    _session: AdminSession,
+    _multiEnvironment = false,


This will be helpful in certain commands to toggle off behaviour like individual confirmations

dejmedus · 2025-07-17T22:10:20Z

packages/theme/src/cli/utilities/theme-command.ts

+          try {
+            await this.command(flags, session, true, {stdout, stderr})
+
+            // eslint-disable-next-line no-catch-all/no-catch-all


Without catching/handling, some command errors (like authentication failures) would prevent subsequent commands from running

graygilmore · 2025-07-21T16:30:45Z

/snapit

github-actions · 2025-07-21T16:33:28Z

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

Test the snapshot by installing your package globally:

pnpm i -g @shopify/[email protected]

Tip

If you get an ETARGET error, install it with NPM and the flag --@shopify:registry=https://registry.npmjs.org

Caution

After installing, validate the version by running just shopify 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.

graygilmore

🎩 went great!

graygilmore · 2025-07-21T16:44:05Z

packages/theme/src/cli/utilities/theme-command.ts

@@ -60,72 +61,125 @@ export default abstract class ThemeCommand extends Command {

    // Single environment or no environment
    if (environments.length <= 1) {
-      const session = await this.ensureAuthenticated(flags)
+      const session = await this.createSession(flags)


Nit: in the future it'd be good to split a name change into a separate commit for an easier git diff!

Sounds good! So its easier to differentiate "cosmetic" changes from actual logic changes/additions?

graygilmore · 2025-07-21T16:50:47Z

packages/theme/src/cli/utilities/theme-command.ts

+    const environmentsMap = await this.loadEnvironments(environments, flags)
+    const validationResults = await this.validateEnvironments(environmentsMap, requiredFlags)
+
+    const commandAllowsForceFlag = 'force' in (this.constructor as typeof ThemeCommand)?.flags


Could we use klass here since we already type cast on L60?

Suggested change

const commandAllowsForceFlag = 'force' in (this.constructor as typeof ThemeCommand)?.flags

const commandAllowsForceFlag = 'force' in klass.flags

100%, thanks!

EvilGenius13

Nice changes! 🎩 went well too. I think we're headed in a good direction with this.

Previously required multi-environment command flags were only taken from the `shopify.theme.toml` file. This commit updates ThemeCommand to accept flags from the CLI as well, with CLI flags taking precedence.

Previously multi-environment theme commands did not prompt for confirmation before running. This commit adds a confirmation prompt that will be displayed if the command accepts `--force` flag and has not been set to force.

dejmedus force-pushed the jb-multi-env branch 2 times, most recently from d8cff92 to d14260f Compare July 17, 2025 18:41

dejmedus force-pushed the jb-multi-env branch from d14260f to 682a7d2 Compare July 17, 2025 20:16

Shopify deleted a comment from github-actions bot Jul 17, 2025

dejmedus commented Jul 17, 2025

View reviewed changes

dejmedus force-pushed the jb-multi-env branch 5 times, most recently from 20c1ea0 to 7be6f14 Compare July 17, 2025 23:35

dejmedus marked this pull request as ready for review July 18, 2025 00:05

dejmedus requested review from a team as code owners July 18, 2025 00:05

graygilmore approved these changes Jul 21, 2025

View reviewed changes

EvilGenius13 approved these changes Jul 21, 2025

View reviewed changes

dejmedus force-pushed the jb-multi-env branch from 7be6f14 to 63521ef Compare July 22, 2025 16:28

graygilmore approved these changes Jul 22, 2025

View reviewed changes

dejmedus added 2 commits July 23, 2025 10:05

Allow multi-env theme commands to accept CLI flags

1f4fd78

Previously required multi-environment command flags were only taken from the `shopify.theme.toml` file. This commit updates ThemeCommand to accept flags from the CLI as well, with CLI flags taking precedence.

Add confirmation prompt to multi-env theme commands

b382a89

Previously multi-environment theme commands did not prompt for confirmation before running. This commit adds a confirmation prompt that will be displayed if the command accepts `--force` flag and has not been set to force.

dejmedus force-pushed the jb-multi-env branch from 63521ef to b382a89 Compare July 23, 2025 16:50

dejmedus added this pull request to the merge queue Jul 23, 2025

Merged via the queue into main with commit 997d4bb Jul 23, 2025
30 checks passed

dejmedus deleted the jb-multi-env branch July 23, 2025 17:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update multi-environment theme command behaviour #6124

Update multi-environment theme command behaviour #6124

dejmedus commented Jul 17, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jul 17, 2025 •

edited

Loading

Uh oh!

dejmedus commented Jul 17, 2025

Uh oh!

github-actions bot commented Jul 17, 2025

Uh oh!

dejmedus Jul 17, 2025

Uh oh!

dejmedus Jul 17, 2025

Uh oh!

graygilmore commented Jul 21, 2025

Uh oh!

github-actions bot commented Jul 21, 2025

Uh oh!

graygilmore left a comment

Uh oh!

graygilmore Jul 21, 2025

Uh oh!

dejmedus Jul 22, 2025

Uh oh!

graygilmore Jul 22, 2025

Uh oh!

graygilmore Jul 21, 2025

Uh oh!

dejmedus Jul 22, 2025

Uh oh!

EvilGenius13 left a comment

Uh oh!

Uh oh!

Uh oh!

	const commandAllowsForceFlag = 'force' in (this.constructor as typeof ThemeCommand)?.flags
	const commandAllowsForceFlag = 'force' in klass.flags

Update multi-environment theme command behaviour #6124

Update multi-environment theme command behaviour #6124

Conversation

dejmedus commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Post-release steps

Measuring impact

Checklist

Uh oh!

github-actions bot commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage report

Test suite run success

Uh oh!

dejmedus commented Jul 17, 2025

Uh oh!

github-actions bot commented Jul 17, 2025

Uh oh!

dejmedus Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

dejmedus Jul 17, 2025

Choose a reason for hiding this comment

Uh oh!

graygilmore commented Jul 21, 2025

Uh oh!

github-actions bot commented Jul 21, 2025

Uh oh!

graygilmore left a comment

Choose a reason for hiding this comment

Uh oh!

graygilmore Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

dejmedus Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

graygilmore Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

graygilmore Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

dejmedus Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

EvilGenius13 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dejmedus commented Jul 17, 2025 •

edited

Loading

github-actions bot commented Jul 17, 2025 •

edited

Loading