Repository navigation
[2025-10] Remove conflict artifacts from form event docs - #4725
Merged
Merged
Conversation
oliverigor
approved these changes
Sep 23, 2026
chadwcarlson
approved these changes
Sep 23, 2026
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.
Background
The 2025-10 Checkout and Customer Account reference pages show committed merge-conflict markers in the events for EmailField, PasswordField, PhoneField, Select, TextArea, and TextField. For example: Checkout EmailField.
This completes the remaining form-event cleanup following #4333 and the NumberField/MoneyField fixes.
Solution
Resolve the six
*ElementEventsdeclarations using the clean descriptions already present in newer releases. On this branch, resolving the conflicts also removes duplicateblurandchangedeclarations while preserving their callback types. Regenerate Checkout and Customer Account documentation, retaining only the six affected entries in each JSON to avoid unrelated generator changes.Include a patch changeset for
@shopify/ui-extensionsso the corrected declarations can ship in the next npm patch. Package publication remains a separate release-maintainer step; the website receives the committed JSON through its docs sync.No forward-port is needed: the corresponding declarations on
2026-04,2026-07, and2026-10-rcare already clean.🎩
yarn docs:checkout 2025-10andyarn docs:customer-account 2025-10succeeded. Local preview copies were routed to an isolated temporary directory.yarn build,yarn type-check, andyarn lintpassed. Ignored Preact entry-point wrappers created by the build were removed before lint, matching CI's separate build/lint jobs.Verified all six interfaces have unique event members and unchanged event names/callback types; generated descriptions and serialized declarations match the source on both surfaces.
Verified the built declarations are clean, each JSON changes exactly six entries, and no conflict markers remain under
packages/ui-extensions/srcorpackages/ui-extensions/docs.git diff --checkand changeset validation passed.Existing limitation:
node packages/ui-extensions/docs/surfaces/checkout/build-docs-targets-json.test.mjsfails because it expectsgenerated/checkout_extensions/test-version/targets.json, while the generator writesgenerated/targets.json. Reproduced with the unmodified branch sources and generated docs.Checklist