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

CLI: Use @storybook/test in template stories #24393

Merged
merged 10 commits into from
Nov 1, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Oct 5, 2023

Closes #24172

What I did

This PR replaces the usage of @storybook/testing-library with the new @storybook/test package, which includes the same utilities.
Because it also includes other utilities such as expect, the play functions are also updated to use the expect.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Check the Page LoggedIn story

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for 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:

    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>

@yannbf yannbf added ci: do not merge cli ci:daily Run the CI jobs that normally run in the daily job. labels Oct 5, 2023
@yannbf yannbf self-assigned this Oct 6, 2023
@yannbf
Copy link
Member Author

yannbf commented Oct 6, 2023

@kasperpeulen it seems like using @storybook/test and @storybook/jest in the same project leads to problems (understandably).

This PR updates only the CLI templates, but because our sandboxes are augmented with extra stories so we can test them via E2E, things fail as those stories use @storybook/jest. 😵

We can update everything, but we'll end up not testing @storybook/jest and @storybook/testing-library anymore this way.

@kasperpeulen kasperpeulen force-pushed the yann/use-test-package-in-template-stories branch from d0e4a2a to 11d1e03 Compare October 27, 2023 14:00
Base automatically changed from kapser/test-package2 to next October 27, 2023 14:54
@kasperpeulen kasperpeulen force-pushed the yann/use-test-package-in-template-stories branch from d6d2600 to c33b724 Compare October 31, 2023 16:10
Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

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

LGTM

@kasperpeulen kasperpeulen added ci:merged Run the CI jobs that normally run when merged. and removed ci:daily Run the CI jobs that normally run in the daily job. labels Oct 31, 2023
@ndelangen
Copy link
Member

@yannbf can this be merged?

@kasperpeulen kasperpeulen merged commit 34cf7f8 into next Nov 1, 2023
15 checks passed
@kasperpeulen kasperpeulen deleted the yann/use-test-package-in-template-stories branch November 1, 2023 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:merged Run the CI jobs that normally run when merged. cli feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use @storybook/test in Storybook CLI template stories
3 participants