Skip to content
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

Changelog and/or fixed documentation link for ui-extensions-react package. #2424

Open
edhgoose opened this issue Oct 21, 2024 · 0 comments
Open
Labels
bug Something isn't working

Comments

@edhgoose
Copy link

Please list the package(s) involved in the issue, and include the version you are using

    "@shopify/ui-extensions-react": "^2024.7"

Describe the bug

Dependabot has opened this PR: mention-me/ShopifyAppV2#72

This is trying to upgrade the ui-extensions-react package.

Unfortunately, no changelog is provided. It's difficult to confirm exactly what has changed and why I should (or shouldn't!) upgrade.

On searching, I found this page: https://www.npmjs.com/package/@shopify/ui-extensions-react, which provides a readme from I assume this page: https://github.com/Shopify/ui-extensions/tree/unstable/packages/ui-extensions-react

On that page is a comment:

Is your extension currently using @shopify/checkout-ui-extensions-react? You can learn what you need to do to upgrade to this API versioned package in the migration guide.

The link referenced (https://github.com/Shopify/ui-extensions/blob/unstable/documentation/upgrade/checkout-ui-extension-api-versioning.md) does not exist.

I'm unsure if I'm supposed to be using this package or not - or whether there's a different version I'm supposed to be using. I'm assuming I'm meant to be using it.

I would like for either:

  1. The link to be fixed so I know how to remove / replace / update this package if I'm meant to replace it.
  2. A changelog to be published alongside dependabot (or renovate) if I'm supposed to keep it.

Steps to reproduce the behavior:

  1. View a PR opened by Dependabot, like Bump @shopify/ui-extensions-react from 2024.7.0 to 2024.10.0 mention-me/ShopifyAppV2#72
  2. Confirm there's no changelog or any details
  3. Search for the package on Google. Observe one of the results is https://www.npmjs.com/package/@shopify/ui-extensions-react, which has a README with a broken URL.
  4. Confirm the original file (https://github.com/Shopify/ui-extensions/tree/unstable/packages/ui-extensions-react) also has the broken link.

Expected behavior

  1. A changelog would be published alongside Dependabot
  2. The link referenced would work.

Screenshots

Additional context

@edhgoose edhgoose added the bug Something isn't working label Oct 21, 2024
@edhgoose edhgoose changed the title Changelog or fixed documentation link for ui-extensions-react package. Changelog and/or fixed documentation link for ui-extensions-react package. Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant