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

Portable stories: Introduce experimental Playwright CT API and Support for more renderers #26063

Merged
merged 195 commits into from
Mar 18, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Feb 16, 2024

Closes #26026

What I did

This PR is a collection of many different satellite PRs that got worked on and reviewed by both @yannbf and @JReinhold, introducing the following work:

  • Experimental Playwright CT API for React
  • Experimental Playwright CT API for Vue3
  • Portable stories support for Next.js (Jest)
  • Portable stories support for Svelte (Vitest)
  • Distribute CJS entry points for preview entries of addons
  • API docs for portable stories
  • Recipes for using portable stories in Jest, Vitest and Playwright CT (for applicable renderers)

A lot of the file changes are actually the introduction of a "portable-stories-kitchen-sink" test storybook directory, which includes all the necessary files for testing the different integrations locally and in CI.

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. Follow instructions for portable stories in Jest, Vitest or Playwright CT

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:normal build Internal-facing build tooling & test updates labels Feb 16, 2024
@yannbf
Copy link
Member Author

yannbf commented Feb 16, 2024

@SocketSecurity ignore-all

@storybookjs storybookjs deleted a comment from socket-security bot Feb 16, 2024
@storybookjs storybookjs deleted a comment from socket-security bot Feb 16, 2024
@yannbf yannbf enabled auto-merge March 18, 2024 13:14
@yannbf yannbf added ci:daily Run the CI jobs that normally run in the daily job. and removed ci:merged Run the CI jobs that normally run when merged. labels Mar 18, 2024
@yannbf yannbf disabled auto-merge March 18, 2024 14:50
@yannbf yannbf merged commit 7d282b2 into next Mar 18, 2024
107 of 120 checks passed
@yannbf yannbf deleted the feature/portable-stories-improvements branch March 18, 2024 14:51
@github-actions github-actions bot mentioned this pull request Mar 18, 2024
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:daily Run the CI jobs that normally run in the daily job. feature request portable stories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Portable stories - Set up examples for Jest, Vitest, Playwright CT
4 participants