-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
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
Documentation: Document @storybook/test package #24263
Conversation
Noting for posterity: Once this PR is merged, two things need to happen, in this order (ping me to do it):
|
@kasperpeulen @yannbf Is this ready? |
Like we discussed yesterday, there might be the need of writing a migration note, and checking whether the new package clashes with the other packages (sb/testing-lib, sb/jest) @kasperpeulen can you do that? |
@kylegach I would like to merge this PR and get it in the docs, if you are okay with that :) @yannbf I found that the packages don't clash anymore, and can be used together in stories, when migrating. I think it would be good already start documenting the test package also in the README of the package as @IanVS suggested. |
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!
Yes please, feel free to do that! |
629671c
to
c92f92a
Compare
Relates to #23871
What I did
This PR proposes changes to the documentation in Storybook 8, following the requirements of #23871, to:
fn
functions and its connection to actions panelChecklist 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/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>