Skip to content

Fix repeated event config diffs when API versions are inherited - #8677

Closed
pobed2 wants to merge 1 commit into
mainfrom
pierre-events-inherited-api-version
Closed

pobed2 wants to merge 1 commit into
mainfrom
pierre-events-inherited-api-version

Conversation

@pobed2

@pobed2 pobed2 commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

shopify app deploy reports unchanged events configuration as updated when a subscription omits api_version and inherits [events].api_version. The server stores the inherited version on each subscription, while the CLI compares it with a local config that still omits the field.

WHAT is this pull request doing?

Resolve inherited subscription versions in the existing local-to-remote events transform, alongside relative URI resolution. Deploy comparison and upload then use the same effective versions as the server, without modifying the local TOML or requiring a server change.

Explicit overrides remain intact. Regression tests cover unchanged inherited and explicit versions, changing or removing an override, and changing the default version.

How to manually test your changes?

Use an app whose TOML sets [events].api_version and omits api_version on an event subscription:

pnpm shopify app deploy --path /path/to/app
pnpm shopify app deploy --path /path/to/app

The second deploy should show no events update. Setting a different subscription version, or removing an override that differs from the default, should still show an update.

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset

Resolve inherited versions in the outbound events configuration so deploy
comparison matches the server's materialized subscriptions.

Co-Authored-By: Codex <[email protected]>
@github-actions github-actions Bot added the Area: @shopify/app @shopify/app package issues label Sep 27, 2026
@pobed2 pobed2 closed this Oct 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/app @shopify/app package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant