Skip to content

feat!(gatsby-source-shopify): upgrade from Shopify API version 2022-04 to 2024-04 #39082

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

Conversation

serhalp
Copy link
Contributor

@serhalp serhalp commented Sep 6, 2024

Description

This upgrades the default Shopify API version in gatsby-source-shopify from 2022-04 to 2024-04.

We've made this upgrade seamless for Gatsby users by keeping the surface backwards-compatible. There are no breaking changes in fields or types.

However, when upgrading you should carefully review the Shopify API release notes because they contain several subtle behavioural changes that cannot be controlled by Gatsby. We've marked this as a major release for this reason.

See the release notes for each version here:

We didn't surface all new additional fields that have been added by Shopify in these versions. If you have fields you would like to see added, please open an issue or PR.

Related Issues

#39129

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Sep 6, 2024
@pieh pieh added topic: source-shopify Related to the gatsby-source-shopify plugin and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Sep 10, 2024
@pieh pieh force-pushed the serhalp/frp-1284-shopify-api-has-breaking-changes-and-thus-gatsby-source branch from ab17f2e to ca66063 Compare December 18, 2024 15:01
@pieh pieh marked this pull request as ready for review December 18, 2024 15:55
@serhalp serhalp changed the title chore!(gatsby-source-shopify): upgrade from Shopify API version 2022-04 to 2024-04 feat!(gatsby-source-shopify): upgrade from Shopify API version 2022-04 to 2024-04 Dec 18, 2024
@pieh
Copy link
Contributor

pieh commented Dec 18, 2024

Successfully published:
 - [email protected]
lerna success published 1 package

Canary version released for testing purposes

Copy link
Contributor Author

@serhalp serhalp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Let's add a prominent note near the top of https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-source-shopify that the package uses version 2024-04 and link to it?

@pieh pieh merged commit 8252e82 into master Jan 2, 2025
38 checks passed
@pieh pieh deleted the serhalp/frp-1284-shopify-api-has-breaking-changes-and-thus-gatsby-source branch January 2, 2025 12:07
pieh pushed a commit that referenced this pull request Jan 2, 2025
…4 to 2024-04 (#39082)

* chore!(gatsby-source-shopify): upgrade to api version 2024-04

See breaking changes in:
- https://shopify.dev/docs/api/release-notes/previous-versions/2022-07
- https://shopify.dev/docs/api/release-notes/previous-versions/2022-10
- https://shopify.dev/docs/api/release-notes/previous-versions/2023-01
- https://shopify.dev/docs/api/release-notes/previous-versions/2023-04

* test: fix fixture syntax and update snapshots

* chore: handle Count type

* fix: handle intentory level

* test: update snapshots and mocks

* test: update variants fixture

* test: update inventory level mock

* fix: minimize breaking changes by keeping Int type for count fields

* fix: mark productBased as deprecated

* address review comments

* test: update snapshots

---------

Co-authored-by: pieh <[email protected]>
(cherry picked from commit 8252e82)
pieh pushed a commit that referenced this pull request Jan 2, 2025
…4 to 2024-04 (#39082) (#39202)

* chore!(gatsby-source-shopify): upgrade to api version 2024-04

See breaking changes in:
- https://shopify.dev/docs/api/release-notes/previous-versions/2022-07
- https://shopify.dev/docs/api/release-notes/previous-versions/2022-10
- https://shopify.dev/docs/api/release-notes/previous-versions/2023-01
- https://shopify.dev/docs/api/release-notes/previous-versions/2023-04

* test: fix fixture syntax and update snapshots

* chore: handle Count type

* fix: handle intentory level

* test: update snapshots and mocks

* test: update variants fixture

* test: update inventory level mock

* fix: minimize breaking changes by keeping Int type for count fields

* fix: mark productBased as deprecated

* address review comments

* test: update snapshots

---------

Co-authored-by: pieh <[email protected]>
(cherry picked from commit 8252e82)

Co-authored-by: Philippe Serhal <[email protected]>
@pieh
Copy link
Contributor

pieh commented Jan 3, 2025

This was now released in stable new major version:

Successfully published:
 - [email protected]
lerna success published 1 package

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: source-shopify Related to the gatsby-source-shopify plugin
Projects
Status: Published
Development

Successfully merging this pull request may close these issues.

3 participants