[Feature] Extend ExtensionInstance.deployConfig to include app config info#7697
Draft
EliasJRH wants to merge 1 commit into
Draft
[Feature] Extend ExtensionInstance.deployConfig to include app config info#7697EliasJRH wants to merge 1 commit into
EliasJRH wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the extension deployment configuration hook so extension specifications can access the app’s configuration (e.g., app URLs) when building their deployConfig payload.
Changes:
- Extends
ExtensionSpecification.deployConfigsignature to accept an optionalcontextcontainingappConfiguration. - Updates
ExtensionInstance.deployConfigto passappConfigurationinto the specification’sdeployConfigcall.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/app/src/cli/models/extensions/specification.ts | Extends the deployConfig function type to accept a context that can carry appConfiguration. |
| packages/app/src/cli/models/extensions/extension-instance.ts | Passes appConfiguration from the callsite into specification.deployConfig via the new context argument. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
94302f0 to
d945cec
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Part of https://github.com/Shopify/flow/issues/21604, allows app extensions, such as Flow actions, to access application configuration data such as the application url.
WHAT is this pull request doing?
This PR extends the
ExtensionInstance.deployConfigmethod such that it requires anappConfigurationwhich is obtained from the callsite inextension-instance.ts. Extensions can now implementdeployConfigin theircreateExtensionSpecificationfunctions and use the fields in the passedappConfigurationHow to test your changes?
Post-release steps
Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add