-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
Documentation: Migration note on removal addon-essentials #30995
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
…addon-essentials` and clarify changes in package manager support. Adjusted formatting for consistency and improved clarity on deprecated features and required updates for users.
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.
Pull Request Overview
This PR updates the migration documentation for Storybook 9.0. It introduces a new section detailing the removal of addon-essentials, updates import paths, and refines formatting for improved clarity and consistency.
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.
LGTM
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
Co-authored-by: Valentin Palkovic <[email protected]>
MIGRATION.md
Outdated
<h1>Migration</h1> | ||
### Addon-a11y: Replaced experimental `ally-test` tag behavior with `parameters.a11y.test` | ||
|
||
- [From version 8.x to 9.0.0](#from-version-8x-to-900) |
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 caught this regression in this PR of mine:
#30909
So this is bringing back the correct content @valentinpalkovic
View your CI Pipeline Execution ↗ for commit 8bb4dad.
☁️ Nx Cloud last updated this comment at |
What I did
This pull request includes several updates to the
MIGRATION.md
file, mainly focusing on the removal of deprecated items, updates to the addon essentials, and various formatting corrections. The most important changes are summarized below:Addon Essentials
@storybook/addon-essentials
and instructions for users on how to manually add@storybook/addon-docs
if needed.Deprecated Items and Updates
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>
Greptile Summary
This PR refines the MIGRATION.md file for Storybook 9.0 by adding a dedicated section on the removal of @storybook/addon-essentials and improving formatting.