Solved

App Bridge version 3 release notes?

few_meaning
Shopify Partner
20 3 2

It looks like the Shopify Bridge (@shopify/app-bridge on NPM) had a major version bump two months ago. Does this kind of thing get announced anywhere? Is there some way to stay in the loop

 

How does one find out what the changes are/what breaking changes were made? Is a changelog something Shopify puts out?

 

The docs say:

Strict versioning using SemVer.

Accepted Solution (1)

CharlieD
Shopify Staff
15 4 7

This is an accepted solution.

Hi @few_meaning!

Charlie here from the App Bridge team. We have a migration guide for upgrading from v2 to v3 on the Shopify Dev Docs here. It should be quite low effort, just a couple breaking changes to the useToast and useContextualSaveBar hooks!

All major version bumps will have a migration guide posted to the same place. As for ongoing release notes, they can currently be seen via the package CHANGELOG.md's. Stay tuned for improved release notes for all App Bridge packages!

Hope that helps!

To learn more visit the Shopify Help Center or the Community Blog.

View solution in original post

Replies 3 (3)

CharlieD
Shopify Staff
15 4 7

This is an accepted solution.

Hi @few_meaning!

Charlie here from the App Bridge team. We have a migration guide for upgrading from v2 to v3 on the Shopify Dev Docs here. It should be quite low effort, just a couple breaking changes to the useToast and useContextualSaveBar hooks!

All major version bumps will have a migration guide posted to the same place. As for ongoing release notes, they can currently be seen via the package CHANGELOG.md's. Stay tuned for improved release notes for all App Bridge packages!

Hope that helps!

To learn more visit the Shopify Help Center or the Community Blog.

few_meaning
Shopify Partner
20 3 2

That does help, thank you. Can I suggest adding something to the readme (that renders on the NPM page)? A link to the unpkg changelog or even a call out to Shopify docs you linked here might have made it more apparent.

 

At the same time, it seems like the relationship with SemVer is a bit more complicated than it claims, or there's a structure that's not obvious to a consumer of the packages:

# [3.0.0](https://github.com/Shopify/app-bridge/compare/v2.1.0...v3.0.0) (2022-05-24)

**Note:** Version bump only for package @shopify/app-bridge

As far as I understand, app-bridge and app-bridge-utils have not had a backwards incompatible change, only app-bridge-react?

CharlieD
Shopify Staff
15 4 7

That's a great idea! Thank you.

It is a bit more complicated, as we have a few packages that we want to keep in sync: app-bridgeapp-bridge-utils, and app-bridge-react. Maintaining them as a single version number makes it easier to avoid any version mismatches. That does result in SemVer being used for the App Bridge packages as a whole but not necessarily the individual packages. I'll look into making this a bit more clear in the README's. Thank you for bringing this up!

That's correct, there were only breaking changes in app-bridge-react for v3.

To learn more visit the Shopify Help Center or the Community Blog.