GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 02:31:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add brief guide to running e2e tests

Browse Source
This commit is contained in:
Ian VanSchooten 2022-02-22 10:20:01 -05:00
parent 75b841912c
commit 45911900d3
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/contribute/code.md
View File

@ -40,6 +40,14 @@ If everything is working as it should, you should see the `example/cra-ts-essent
![Example Storybook running](./storybook-cra-examples-optimized.png)
### End-to-end tests (e2e)
In order to test key parts of storybook functionality, end-to-end tests using [cypress](https://www.cypress.io/) are run during CI. If you would like to also run these tests on your own machine, there are a few steps to take:
1. Make sure that you have built storybook on your branch with `yarn bootstrap --core`.
2. Publish storybook packages to a local registry in one terminal: `yarn local-registry --port 6000 --open --publish`
3. In a second terminal, create a repro against the local registry and run cypress against it: `yarn test:e2e-framework`.
## Start developing
Now that you've [verified your setup](#sanity-check), it's time to jump into code. The simplest way to do this is to run one of the examples in one terminal window and the interactive build process in a separate terminal.