Skip to content

Commit

Permalink
Update addon storyshot puppeteer doc (#9526)
Browse files Browse the repository at this point in the history
Update addon storyshot puppeteer doc
  • Loading branch information
shilman committed Jan 18, 2020
2 parents dfffc21 + 792064b commit 4a5508d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
12 changes: 12 additions & 0 deletions MIGRATION.md
Expand Up @@ -9,6 +9,7 @@
- [Deprecate displayName parameter](#deprecate-displayname-parameter)
- [Unified docs preset](#unified-docs-preset)
- [Simplified hierarchy separators](#simplified-hierarchy-separators)
- [Addon StoryShots Puppeteer uses external puppeteer](#addon-storyshots-puppeteer-uses-external-puppeteer)
- [From version 5.1.x to 5.2.x](#from-version-51x-to-52x)
- [Source-loader](#source-loader)
- [Default viewports](#default-viewports)
Expand Down Expand Up @@ -220,6 +221,17 @@ addParameters({

NOTE: it is no longer possible to have some stories with roots and others without. If you want to keep the old behavior, simply add a root called "Others" to all your previously unrooted stories.

### Addon StoryShots Puppeteer uses external puppeteer

To give you more control on the Chrome version used when running StoryShots Puppeteer, `puppeteer` is no more included in the addon dependencies. So you can now pick the version of `puppeteer` you want and set it in your project.

If you want the latest version available just run:
```sh
yarn add puppeteer --dev
OR
npm install puppeteer --save-dev
```

## From version 5.1.x to 5.2.x

### Source-loader
Expand Down
4 changes: 3 additions & 1 deletion addons/storyshots/storyshots-puppeteer/README.md
Expand Up @@ -8,9 +8,11 @@ Add the following modules into your app.
npm install @storybook/addon-storyshots-puppeteer puppeteer --save-dev
```

⚠️ As of Storybook 5.3 `puppeteer` is no more included in addon dependencies and must be added to your project directly.

## Configure Storyshots for Puppeteeer tests

/\*\ **React-native** is **not supported** by this test function.
⚠️ **React-native** is **not supported** by this test function.

When willing to run Puppeteer tests for your stories, you have two options:

Expand Down

1 comment on commit 4a5508d

@vercel
Copy link

@vercel vercel bot commented on 4a5508d Jan 18, 2020

Choose a reason for hiding this comment

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

Please sign in to comment.