Skip to content

introduce --version flag to Bulk Operations CLI #6684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jordanverasamy merged 2 commits into from
Dec 5, 2025
Merged

introduce --version flag to Bulk Operations CLI #6684

jordanverasamy merged 2 commits into from
Dec 5, 2025

Conversation

@jordanverasamy
Copy link
Contributor

@jordanverasamy jordanverasamy commented Dec 4, 2025 •
edited
Loading

WHY are these changes introduced?

https://github.com/shop/issues-api-foundations/issues/1138

Users should be able to run their bulk operations against any valid and supported API version.

WHAT is this pull request doing?

Allows users to run their bulk operations against a configurable version. If not provided, defaults to latest stable version.

How to test your changes?

Try running shopify app bulk execute with various values of --version.

Invalid version, e.g. --version=1998-01:

image

Valid stable version, e.g. --version=2025-04:

image

--version=unstable:

image

--version not provided at all:

image

@jordanverasamy jordanverasamy requested review from a team as code owners December 4, 2025 03:14
@jordanverasamy jordanverasamy marked this pull request as draft December 4, 2025 03:14
@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run pnpm changeset add to track your changes and include them in the next release CHANGELOG.

Caution

DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release.

@jordanverasamy jordanverasamy self-assigned this Dec 4, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025 •
edited
Loading

Coverage report

St.❔
 Category Percentage Covered / Total
🟡 Statements
79.17% (-0.06% 🔻)
 13862/17509
🟡 Branches
73.13% (+0.03% 🔼)
 6773/9261
🟡 Functions
79.33% (-0.04% 🔻)
 3555/4481
🟡 Lines
79.53% (-0.05% 🔻)
 13095/16465
Show new covered files 🐣
St.❔
 File Statements Branches Functions Lines
🟢
... / admin-as-app.ts
 100% 100% 100% 100%
🟢
... / bulk-operation-run-mutation.ts
 100% 100% 100% 100%
🟢
... / bulk-operation-run-query.ts
 100% 100% 100% 100%
🟢
... / get-bulk-operation-by-id.ts
 100% 100% 100% 100%
🟢
... / list-bulk-operations.ts
 100% 100% 100% 100%
🟢
... / staged-uploads-create.ts
 100% 100% 100% 100%
🔴
... / execute.ts
 0% 0% 0% 0%
🔴
... / status.ts
 0% 0% 0% 0%
🔴
... / pull.ts
 0% 100% 0% 0%
🔴
... / pull.ts
 0% 0% 0% 0%
🟢
... / bulk-operation-status.ts
 96% 90.63% 100% 100%
🟢
... / download-bulk-operation-results.ts
 100% 100% 100% 100%
🟢
... / execute-bulk-operation.ts
 93.06% 86.96% 100% 93.94%
🟢
... / format-bulk-operation-status.ts
 100% 100% 100% 100%
🟢
... / run-mutation.ts
 100% 100% 100% 100%
🟢
... / run-query.ts
 100% 100% 100% 100%
🟡
... / stage-file.ts
 72.73% 62.5% 83.33% 71.88%
🟢
... / watch-bulk-operation.ts
 100% 100% 100% 100%
🔴
... / promiseWithResolvers.ts
 33.33% 50% 50% 33.33%
Show files with reduced coverage 🔻
St.❔
 File Statements Branches Functions Lines
🟢
... / extension-instance.ts
84.8% (+0.23% 🔼)
77.6% (-0.91% 🔻)
92.06% (+0.13% 🔼)
85.11% (+0.24% 🔼)
🟡
... / specification.ts
 69.09%
75.61% (+2.44% 🔼)
76.47% (-1.31% 🔻)
 68.75%
🟢
... / ui_extension.ts
85.38% (-9.44% 🔻)
72.34% (-8.91% 🔻)
84% (-16% 🔻)
88% (-8.46% 🔻)
🟢
... / developer-platform-client.ts
84.62% (-1.5% 🔻)
73.68% (+3.1% 🔼)
81.82% (+1.82% 🔼)
90.63% (-2.71% 🔻)
🟢
... / api.ts
87.07% (-0.43% 🔻)
76.71% (-0.1% 🔻)
 100%
86.49% (-0.43% 🔻)
🟢
... / ConcurrentOutput.tsx
98.36% (-1.64% 🔻)
92% (-4% 🔻)
 100%
98.33% (-1.67% 🔻)
🟢
... / SingleTask.tsx
84.21% (-15.79% 🔻)
50% (-50% 🔻)
80% (-20% 🔻)
84.21% (-15.79% 🔻)
🔴
... / ui.tsx
50.82% (-0.79% 🔻)
42.86% (-5.53% 🔻)
54.55% (+1.42% 🔼)
50% (-0.82% 🔻)
🟢
... / console.ts
81.82% (+15.15% 🔼)
75% (-25% 🔻)
100% (+33.33% 🔼)
81.82% (+15.15% 🔼)
🔴
... / dev.ts
14.29% (+0.95% 🔼)
3.13% (+0.18% 🔼)
50% (-7.14% 🔻)
14.29% (+0.95% 🔼)
🟢
... / init.ts
88% (-0.89% 🔻)
71.43% (+4.76% 🔼)
86.67% (+4.85% 🔼)
88% (-0.89% 🔻)
🟢
... / storefront-renderer.ts
90.2% (-0.54% 🔻)
 78.95%
81.82% (-1.52% 🔻)
90.2% (-0.54% 🔻)
🟡
... / theme-polling.ts
67.12% (-0.93% 🔻)
 68.75% 78.57%
66.67% (-0.98% 🔻)

Test suite run success

3456 tests passing in 1397 suites.

Report generated by 🧪jest coverage report action from e0bace3

@jordanverasamy jordanverasamy force-pushed the jtv/add-version-flag-to-bulk-ops-cli branch from a532547 to 4f5de08 Compare December 4, 2025 19:13
@jordanverasamy Graphite App
Copy link
Contributor Author

jordanverasamy commented Dec 4, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@jordanverasamy jordanverasamy force-pushed the jtv/add-version-flag-to-bulk-ops-cli branch 9 times, most recently from 0b94202 to d889f70 Compare December 4, 2025 20:40
jordanverasamy
jordanverasamy commented Dec 5, 2025
View reviewed changes
packages/app/src/cli/api/graphql/bulk-operations/mutations/bulk-operation-run-query.graphql
bulkOperationRunQuery(
query: $query
# Set to false to optimize for speed over grouped results
groupObjects: false
Copy link
Contributor Author

@jordanverasamy jordanverasamy Dec 5, 2025

Choose a reason for hiding this comment

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

Removing this argument so that this executable document will be compatible with all supported API versions. (API versions before 2025-07 do not support groupObjects.)

More info here.

@jordanverasamy jordanverasamy force-pushed the jtv/add-version-flag-to-bulk-ops-cli branch from 282b3a1 to 6a5c8ee Compare December 5, 2025 01:24
@jordanverasamy jordanverasamy marked this pull request as ready for review December 5, 2025 01:34
@jordanverasamy jordanverasamy force-pushed the jtv/add-version-flag-to-bulk-ops-cli branch 2 times, most recently from 34bbdc4 to 081d32e Compare December 5, 2025 01:38
@gonzaloriestra Graphite App
Copy link
Contributor

gonzaloriestra commented Dec 5, 2025

/snapit

@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2025

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

Test the snapshot by installing your package globally:

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

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.

gonzaloriestra
gonzaloriestra approved these changes Dec 5, 2025
View reviewed changes
Copy link
Contributor

@gonzaloriestra gonzaloriestra left a comment

Choose a reason for hiding this comment

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

LGTM!

@jordanverasamy jordanverasamy force-pushed the jtv/add-version-flag-to-bulk-ops-cli branch from 081d32e to e0bace3 Compare December 5, 2025 18:57
@jordanverasamy jordanverasamy added this pull request to the merge queue Dec 5, 2025
Merged via the queue into main with commit 22deb5f Dec 5, 2025
25 checks passed
@jordanverasamy jordanverasamy deleted the jtv/add-version-flag-to-bulk-ops-cli branch December 5, 2025 19:14
@jordanverasamy jordanverasamy mentioned this pull request Dec 5, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gonzaloriestra gonzaloriestra gonzaloriestra approved these changes

@ericlee878 ericlee878 Awaiting requested review from ericlee878

@nickwesselman nickwesselman Awaiting requested review from nickwesselman

Assignees

@jordanverasamy jordanverasamy

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jordanverasamy @gonzaloriestra @nickwesselman