-
-
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
Docs: Document deprecation of storyshots #23863
Conversation
}; | ||
``` | ||
|
||
When running in [stories.json mode](./test-runner#storiesjson-mode), tests are generated in a temporary folder and snapshots get stored alongside them. You will need to [`--eject`](./test-runner#configure) and configure a custom [`snapshotResolver`](https://jestjs.io/docs/configuration#snapshotresolver-string) to store them elsewhere, e.g. in your working directory: |
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.
@yannbf — Should this be "index.json. mode"? The README uses that (and --stories-json
isn't on the page), but the test runner docs page apparently hasn't been updated.
If your answer is "yes" to the above, I'll update the test runner docs, too (unless you tell me not to).
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.
@yannbf ?
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.
Hey! Index-json is preferred, as is the new way forward. stories-json is still available and works for Storybook 6 (which does not have an index.json file), but will likely be removed in the future
57ee1c1
to
fe34928
Compare
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.
This is great work @kylegach ! Appreciate you taking the time to put together this pull request and provide some guidance to our readers for storyshots deprecation.
I left some minor items for you to look into, but on my end, this is good to go.
fe34928
to
84df4a3
Compare
- Add equivalent test-runner instructions
- Turn code example into snippets - Fix link
84df4a3
to
53206f0
Compare
74f864d
to
49f6082
Compare
49f6082
to
ab7abd2
Compare
- Remove superfluous `storybook-` prefix - Formatting
ab7abd2
to
aa5510a
Compare
Closes #22263
What I did
How to test
storyshots-docs-migration
Checklist
MIGRATION.MD
Maintainers
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
["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]
🦋 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>