Skip to content
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

Merged
merged 5 commits into from
Aug 29, 2023
Merged

Conversation

kylegach
Copy link
Contributor

Closes #22263

What I did

  • Document deprecation of storyshots
  • Add equivalent test-runner instructions

How to test

  1. Follow the steps in the contributing instructions for this branch, storyshots-docs-migration
  2. Review updates to:

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts
  • Make sure this PR contains one of the labels below.

["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>

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Aug 16, 2023
@kylegach kylegach self-assigned this Aug 16, 2023
@kylegach kylegach requested a review from yannbf August 16, 2023 19:31
};
```

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:
Copy link
Contributor Author

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

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

@kylegach kylegach force-pushed the storyshots-docs-migration branch 2 times, most recently from 57ee1c1 to fe34928 Compare August 24, 2023 16:55
Copy link
Contributor

@jonniebigodes jonniebigodes left a 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.

@kylegach kylegach force-pushed the storyshots-docs-migration branch from fe34928 to 84df4a3 Compare August 25, 2023 15:18
- Add equivalent test-runner instructions
- Turn code example into snippets
- Fix link
@kylegach kylegach force-pushed the storyshots-docs-migration branch from 84df4a3 to 53206f0 Compare August 29, 2023 17:10
docs/configure/overview.md Outdated Show resolved Hide resolved
@kylegach kylegach force-pushed the storyshots-docs-migration branch from 74f864d to 49f6082 Compare August 29, 2023 17:42
@kylegach kylegach force-pushed the storyshots-docs-migration branch from 49f6082 to ab7abd2 Compare August 29, 2023 17:45
- Remove superfluous `storybook-` prefix
- Formatting
@kylegach kylegach force-pushed the storyshots-docs-migration branch from ab7abd2 to aa5510a Compare August 29, 2023 17:49
@kylegach kylegach merged commit b92c04b into next Aug 29, 2023
@kylegach kylegach deleted the storyshots-docs-migration branch August 29, 2023 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Storyshots Migration
3 participants