Skip to content

[2025-10] Remove conflict artifacts from form event docs - #4725

Merged
johnnie-chen merged 1 commit into
2025-10from
johnnie/cleanup-form-event-docs-2025-10
Sep 23, 2026
Merged

johnnie-chen merged 1 commit into
2025-10from
johnnie/cleanup-form-event-docs-2025-10

Conversation

@johnnie-chen

@johnnie-chen johnnie-chen commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

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 *ElementEvents declarations using the clean descriptions already present in newer releases. On this branch, resolving the conflicts also removes duplicate blur and change declarations 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-extensions so 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, and 2026-10-rc are already clean.

🎩

  • yarn docs:checkout 2025-10 and yarn docs:customer-account 2025-10 succeeded. Local preview copies were routed to an isolated temporary directory.

  • yarn build, yarn type-check, and yarn lint passed. 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/src or packages/ui-extensions/docs.

  • git diff --check and changeset validation passed.

  • Existing limitation: node packages/ui-extensions/docs/surfaces/checkout/build-docs-targets-json.test.mjs fails because it expects generated/checkout_extensions/test-version/targets.json, while the generator writes generated/targets.json. Reproduced with the unmodified branch sources and generated docs.

Checklist

  • I have 🎩'd these changes (hosted preview pending)
  • I have updated relevant documentation

@johnnie-chen
johnnie-chen marked this pull request as ready for review September 23, 2026 20:03
@johnnie-chen
johnnie-chen requested a review from a team September 23, 2026 20:03
@johnnie-chen
johnnie-chen merged commit e79e08d into 2025-10 Sep 23, 2026
10 checks passed
@johnnie-chen
johnnie-chen deleted the johnnie/cleanup-form-event-docs-2025-10 branch September 23, 2026 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants