Update storybook from version 5.3.20 to 6.1.11 #4835
Merged
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 does this PR do?
Updates the storybook version to the latest, 6.1.11
This update includes changes to the CSF format for the stories. Previously the annotations looked like this:
The above format is deprecated and the annotation should be in this format instead:
This PR fixes the stories to use the new format. This is where the majority of the changes come from. Also stories should no longer use
storiesOf
.In the
storybook/preview.js
file I removedoptions: { showRoots: true, }
becauseshowRoots
is deprecated and the behavior is now done by default and controlled within the.storybook/manager.js
file instead of thepreview.js
file.Also in
storybook/preview.js
I addedlayout: 'fullscreen'
so the component takes up the full canvas instead of having a margin around it. The previous behavior in 5.3.20 was for the component to take up the full canvas.More information about migrating to version 6 of storybook can be found in the version 6 migration guide as well as this more detailed markdown file.
Where should the reviewer start?
Start with the
package.json
andstorybook/preview.js
files.Then look the stories to see the changes from the old CSF annotation format to the new format.
What testing has been done on this PR?
storybook
How should this be manually tested?
storybook
Any background context you want to provide?
What are the relevant issues?
Screenshots (if appropriate)
Do the grommet docs need to be updated?
No
Should this PR be mentioned in the release notes?
No
Is this change backwards compatible or is it a breaking change?
Backwards compatible