-
Notifications
You must be signed in to change notification settings - Fork 103
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.
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
Renames default_placement_reference extension toml property to default_placement #3897
Conversation
Thanks for your contribution! Depending on what you are working on, you may want to request a review from a Shopify team:
|
Coverage report
Test suite run success1662 tests passing in 771 suites. Report generated by 🧪jest coverage report action from 95d5343 |
538494c
to
abe3c22
Compare
This comment has been minimized.
This comment has been minimized.
@@ -31,7 +31,7 @@ const NewExtensionPointSchema = zod.object({ | |||
target: zod.string(), | |||
module: zod.string(), | |||
metafields: zod.array(MetafieldSchema).optional(), | |||
default_placement_reference: zod.string().optional(), | |||
default_placement: zod.string().optional(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this already changed in core?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, this is separate from the core changes for which I have created an issue here https://github.com/orgs/Shopify/projects/3111/views/88?pane=issue&itemId=64006155
This PR just aliases "default_placement" in the toml to "default_placement_reference" when it passes it to the backend.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure to add a changeset before you ship this PR
0aedc17
to
95d5343
Compare
WHY are these changes introduced?
Fixes https://github.com/Shopify/core-issues/issues/70722
Homogenizing the terminology to "placement" instead of "placement_reference" et al.
WHAT is this pull request doing?
Just renames the key used by developers. This is an unreleased feature (not yet enabled in core), so we want to get the terminology correct before release. Does not rename the values passed on to core.
How to test your changes?
The process is to have a local copy of CLI point at an spin instance, and then to deploy a locally developed ui extension on that instance.
In the new app directory:
Configure your extension toml to include
default_placement
. ex:back in your CLI directory start the server. ex:
deploy the app
The app should deploy successfully. Or if you use an invalid value for default_placement you should get an error.
Post-release steps
n/a
Measuring impact
How do we know this change was effective? Please choose one:
Checklist
dev
ordeploy
have been reflected in the internal flowchart.