-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Conversation
@yannbf I'd suggest rewording the message to:
|
@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] FAQsI'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! |
There was a problem hiding this 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!
@joe-vaughan thanks for the copy edits. have updated the issue text 👍 |
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):
Build:
Automigration:
How to test
yarn task --task sandbox --start-from auto --template react-vite/default-ts
Checklist
MIGRATION.MD
Maintainers
make sure to add the
ci:merged
orci:daily
GH label to it.["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]