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

CLI: Warn when community addons are incompatible with Storybook 7 #21863

Merged
merged 1 commit into from Apr 3, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Mar 31, 2023

Relates to #20529

What I did

☝️ See the linked issue for fore info

Added a banner to warn users in case they migrate and still have addons that are not compatible with Storybook 7 yet.

Dev (start command):
image

Build:
image

Automigration:
image

How to test

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. install an incompatible addon e.g. @storybook/addon-knobs
  3. run start-storybook
  4. get the banner

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@winkerVSbecks
Copy link
Contributor

@yannbf I'd suggest rewording the message to:

You’ll likely have to upgrade or disable these addons, and check the following Github issue for more information:

@joe-vaughan
Copy link

joe-vaughan commented Mar 31, 2023

@yannbf -- fully agree with @winkerVSbecks

for suggested rewrite of the main issue page:

Many of Storybook's vast range of addons were made by developers from our community.

Years of changes are packed into Storybook 7. While all core Storybook addons have been updated with Storybook 7 compatibility and many issues have been mitigated through automigrations, it's a massive task to ensure compatibility with all community addons, as many APIs have changed and may no longer be available.

To support developers as they migrate their addons to Storybook 7, we've created an addon migration guide that outlines how to make your addons Storybook 7 compatible. We're keeping up-to-date records of the addons that are and aren't compatible with Storybook 7 and you can explore many of these in the lists below.

Most popular community addons (by npm downloads)

[list]

Community addons

(Please share any addons with us for inclusion in this list)

[list]

FAQs

I'm maintaining an addon. How do I make it compatible with Storybook 7?

We highly recommend consulting our abridged addon migration guide. If you have any questions or encounter any issues, please reach out to Storybook maintainers in the #prerelease channel in the Storybook Discord community.

What do I do if an addon I'm using is incompatible with Storybook 7 but isn't on this list?

To share incompatibility errors, please open an issue on the repo of the relevant addon, asking the author to add Storybook 7 compatibility, and share this page with them for reference.

It's also really useful for us to know which addons aren't yet compatible, so please consider adding a comment here, especially if the addon is popular and causes a critical failure.

Finally, if you have the resources, please consider helping migrate that addon yourself!

@shilman shilman changed the title CLI: warn users when they have community addons that might not be compatible with Storybook 7 CLI: Warn users when their community addons are incompatible with Storybook 7 Apr 1, 2023
@shilman shilman changed the title CLI: Warn users when their community addons are incompatible with Storybook 7 CLI: Warn when community addons are incompatible with Storybook 7 Apr 1, 2023
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

I think the current phrasing is good. We don't actually know the extent to which each addon is broken (or not) in 7.0, so we don't need to alarm users unnecessarily. As we get more visibility into which addons are broken and how badly, we can update the message/list accordingly. Merging!

@shilman shilman merged commit e55cbff into next Apr 3, 2023
30 checks passed
@shilman shilman deleted the feat/unsupported-addons-message branch April 3, 2023 04:23
@shilman
Copy link
Member

shilman commented Apr 3, 2023

@joe-vaughan thanks for the copy edits. have updated the issue text 👍

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.

None yet

4 participants