Docs: Add migration notes about @storybook/router#Route
#25807
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JReinhold
added
documentation
ci:docs
JReinhold
commented
Jan 30, 2024
Comment on lines
-632
to
-638
| #### React v18 in the manager UI (including addons) | ||
|
|
||
| Storybook 7 used React 16 in the manager. In Storybook 8 this is upgraded to react v18. | ||
| Addons that inject UI into panels, tools, etc. are possibly affected by this. | ||
|
|
||
| Addon authors are advised to upgrade to react v18. | ||
|
|
There was a problem hiding this comment.
This was already documented further up: https://github.com/storybookjs/storybook/blob/jeppe/route-migration/MIGRATION.md#manager-addons-are-now-rendered-with-react-18
There was a problem hiding this comment.
Can you check whether there is any link or reference to the section that was removed?
There was a problem hiding this comment.
Good call. An org-wide search on the link didn't find any references.
ndelangen
reviewed
Jan 30, 2024
Comment on lines
+75
to
+85
| - [CommonJS with Vite is deprecated](#commonjs-with-vite-is-deprecated) | ||
| - [Using implicit actions during rendering is deprecated](#using-implicit-actions-during-rendering-is-deprecated) | ||
| - [typescript.skipBabel deprecated](#typescriptskipbabel-deprecated) | ||
| - [Primary doc block accepts of prop](#primary-doc-block-accepts-of-prop) | ||
| - [Addons no longer need a peer dependency on React](#addons-no-longer-need-a-peer-dependency-on-react) | ||
| - [From version 7.4.0 to 7.5.0](#from-version-740-to-750) | ||
| - [`storyStoreV6` and `storiesOf` is deprecated](#storystorev6-and-storiesof-is-deprecated) | ||
| - [`storyIndexers` is replaced with `experimental_indexers`](#storyindexers-is-replaced-with-experimental_indexers) | ||
| - [`storyStoreV6` and `storiesOf` is deprecated](#storystorev6-and-storiesof-is-deprecated) | ||
| - [`storyIndexers` is replaced with `experimental_indexers`](#storyindexers-is-replaced-with-experimental_indexers) | ||
| - [From version 7.0.0 to 7.2.0](#from-version-700-to-720) | ||
| - [Addon API is more type-strict](#addon-api-is-more-type-strict) | ||
| - [Addon-controls hideNoControlsWarning parameter is deprecated](#addon-controls-hidenocontrolswarning-parameter-is-deprecated) | ||
| - [Addon API is more type-strict](#addon-api-is-more-type-strict) | ||
| - [Addon-controls hideNoControlsWarning parameter is deprecated](#addon-controls-hidenocontrolswarning-parameter-is-deprecated) |
There was a problem hiding this comment.
This is just (automatically) updating the TOC to match the headings.
https://github.com/storybookjs/storybook/blob/jeppe/route-migration/MIGRATION.md?plain=1#L1066-L1074
kylegach
approved these changes
Jan 30, 2024
14 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
Follow-up to #25787 , documenting the removal of
hideOnlyfrom<Route />.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:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam 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>