Skip to content

Commit

Permalink
4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
shilman committed Oct 29, 2018
1 parent 19352c7 commit a313e27
Show file tree
Hide file tree
Showing 79 changed files with 371 additions and 414 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ object OpenSourceProjects_Storybook_Docs : BuildType({
artifactRules = "docs/public => docs.zip"

params {
param("Deploy branch", "release/3.4")
param("Deploy branch", "release/4.0")
}

vcs {
Expand Down
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

# 4.0.0

2018-October-29

Storybook 4.0 is our first major-version update in over a year! Key improvements include:

- Build tools
Expand Down Expand Up @@ -30,7 +32,7 @@ Storybook 4.0 is our first major-version update in over a year! Key improvements
- CLI-less Node api [#4344](https://github.com/storybooks/storybook/pull/4344)
- Rename CLI to sb [#4345](https://github.com/storybooks/storybook/pull/4345)

There are hundreds of more fixes, features, and tweaks in the 4.0 release. See changelogs for `4.0.0-rc.*` and `4.0.0-alpha.*` for details, the [Storybook 4.0 migration guide](https://medium.com/storybookjs/migrating-to-storybook-4-c65b19a03d2c) for a step-by-step walkthrough, or our [migration docs](MIGRATION.md#from-version-34x-to-40x) for an enumeration of breaking changes.
There are hundreds of more fixes, features, and tweaks in the 4.0 release. See changelogs for `4.0.0-rc.*` and `4.0.0-alpha.*` for details; check out our [migration docs](https://github.com/storybooks/storybook/blob/master/MIGRATION.md#from-version-34x-to-40x) for an enumeration of breaking changes.

# 4.0.0-rc.6

Expand Down
2 changes: 1 addition & 1 deletion MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ If you're using `start-storybook` on CI, you may need to opt out of this using t
We've deprecated the `getstorybook` CLI in 4.0. The new way to install storybook is `sb init`. We recommend using `npx` for convenience and to make sure you're always using the latest version of the CLI:

```
npx -p @storybook/cli@rc sb init
npx -p @storybook/cli sb init
```

### Addon story parameters
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It allows you to browse a component library, view the different states of each c
README for:

- [![Alpha](https://img.shields.io/npm/v/@storybook/core/alpha.svg)](https://github.com/storybooks/storybook)
- [![Latest](https://img.shields.io/npm/v/@storybook/core/latest.svg)](https://github.com/storybooks/storybook/tree/release/3.4)
- [![Latest](https://img.shields.io/npm/v/@storybook/core/latest.svg)](https://github.com/storybooks/storybook/tree/release/4.0)

Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies.

Expand Down Expand Up @@ -55,7 +55,7 @@ First install storybook:

```sh
cd my-react-app
npx -p @storybook/cli@rc sb init
npx -p @storybook/cli sb init
```

If you'd rather set up your project manually, take a look at our [Slow Start Guide](https://storybook.js.org/basics/slow-start-guide/).
Expand All @@ -66,7 +66,7 @@ Once it's installed, you can `npm run storybook` and it will run the development

```sh
cd my-storybook-v2-app
npx -p @storybook/cli@rc sb init
npx -p @storybook/cli sb init
```

It runs a codemod to update all package names. Read all migration details in our [Migration Guide](MIGRATION.md)
Expand All @@ -79,19 +79,19 @@ For additional help, join us [in our Slack](https://now-examples-slackin-rrirkqo

### Supported Frameworks

| Framework | Demo latest | Demo prerelease | |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [React](app/react) | [v3.4.x](https://release-3-4--storybooks-official.netlify.com), [v3.3.x](https://release-3-3--storybooks-official.netlify.com) | [v4.0.0-alpha](https://storybooks-official.netlify.com) | [![React](https://img.shields.io/npm/dt/@storybook/react.svg)](app/react) |
| [React Native](app/react-native) | - | - | [![React Native](https://img.shields.io/npm/dt/@storybook/react-native.svg)](app/react-native) |
| [Vue](app/vue) | [v3.4.x](https://release-3-4--storybooks-vue.netlify.com/), [v3.3.x](https://release-3-3--storybooks-vue.netlify.com/) | [v4.0.0-alpha](https://storybooks-vue.netlify.com/) | [![Vue](https://img.shields.io/npm/dt/@storybook/vue.svg)](app/vue) |
| [Angular](app/angular) | [v3.4.x](https://release-3-4--storybooks-angular.netlify.com/), [v3.3.x](https://release-3-3--storybooks-angular.netlify.com/) | [v4.0.0-alpha](https://storybooks-angular.netlify.com/) | [![Angular](https://img.shields.io/npm/dt/@storybook/angular.svg)](app/angular) |
| [Polymer](app/polymer) | [v3.4.x](https://release-3-4--storybooks-polymer.netlify.com/) | [v4.0.0-alpha](https://storybooks-polymer.netlify.com/) | [![Polymer](https://img.shields.io/npm/dt/@storybook/polymer.svg)](app/polymer) |
| [Mithril](app/mithril) <sup>alpha</sup> | - | [v4.0.0-alpha](https://storybooks-mithril.netlify.com/) | [![Mithril](https://img.shields.io/npm/dt/@storybook/mithril.svg)](app/mithril) |
| [Marko](app/marko) <sup>alpha</sup> | - | [v4.0.0-alpha](https://storybooks-marko.netlify.com/) | [![Marko](https://img.shields.io/npm/dt/@storybook/marko.svg)](app/marko) |
| [HTML](app/html) <sup>alpha</sup> | - | [v4.0.0-alpha](https://storybooks-html.netlify.com/) | [![HTML](https://img.shields.io/npm/dt/@storybook/html.svg)](app/html) |
| [Svelte](app/svelte) <sup>alpha</sup> | - | [v4.0.0-alpha](https://storybooks-svelte.netlify.com/) | [![Svelte](https://img.shields.io/npm/dt/@storybook/svelte.svg)](app/svelte) |
| [Riot](app/riot) <sup>alpha</sup> | - | [v4.0.0-alpha](https://storybooks-riot.netlify.com/) | [![Riot](https://img.shields.io/npm/dt/@storybook/riot.svg)](app/riot) |
| [Ember](app/ember) <sup>alpha</sup> | - | [v4.0.0-alpha](https://storybooks-ember.netlify.com/) | [![Ember](https://img.shields.io/npm/dt/@storybook/ember.svg)](app/ember) |
| Framework | Demo latest | Demo prerelease | |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [React](app/react) | [v3.4.x](https://release-3-4--storybooks-official.netlify.com), [v3.3.x](https://release-3-3--storybooks-official.netlify.com) | [v4.0.0](https://storybooks-official.netlify.com) | [![React](https://img.shields.io/npm/dt/@storybook/react.svg)](app/react) |
| [React Native](app/react-native) | - | - | [![React Native](https://img.shields.io/npm/dt/@storybook/react-native.svg)](app/react-native) |
| [Vue](app/vue) | [v3.4.x](https://release-3-4--storybooks-vue.netlify.com/), [v3.3.x](https://release-3-3--storybooks-vue.netlify.com/) | [v4.0.0](https://storybooks-vue.netlify.com/) | [![Vue](https://img.shields.io/npm/dt/@storybook/vue.svg)](app/vue) |
| [Angular](app/angular) | [v3.4.x](https://release-3-4--storybooks-angular.netlify.com/), [v3.3.x](https://release-3-3--storybooks-angular.netlify.com/) | [v4.0.0](https://storybooks-angular.netlify.com/) | [![Angular](https://img.shields.io/npm/dt/@storybook/angular.svg)](app/angular) |
| [Polymer](app/polymer) | [v3.4.x](https://release-3-4--storybooks-polymer.netlify.com/) | [v4.0.0](https://storybooks-polymer.netlify.com/) | [![Polymer](https://img.shields.io/npm/dt/@storybook/polymer.svg)](app/polymer) |
| [Mithril](app/mithril) <sup>alpha</sup> | - | [v4.0.0](https://storybooks-mithril.netlify.com/) | [![Mithril](https://img.shields.io/npm/dt/@storybook/mithril.svg)](app/mithril) |
| [Marko](app/marko) <sup>alpha</sup> | - | [v4.0.0](https://storybooks-marko.netlify.com/) | [![Marko](https://img.shields.io/npm/dt/@storybook/marko.svg)](app/marko) |
| [HTML](app/html) <sup>alpha</sup> | - | [v4.0.0](https://storybooks-html.netlify.com/) | [![HTML](https://img.shields.io/npm/dt/@storybook/html.svg)](app/html) |
| [Svelte](app/svelte) <sup>alpha</sup> | - | [v4.0.0](https://storybooks-svelte.netlify.com/) | [![Svelte](https://img.shields.io/npm/dt/@storybook/svelte.svg)](app/svelte) |
| [Riot](app/riot) <sup>alpha</sup> | - | [v4.0.0](https://storybooks-riot.netlify.com/) | [![Riot](https://img.shields.io/npm/dt/@storybook/riot.svg)](app/riot) |
| [Ember](app/ember) <sup>alpha</sup> | - | [v4.0.0](https://storybooks-ember.netlify.com/) | [![Ember](https://img.shields.io/npm/dt/@storybook/ember.svg)](app/ember) |

### Sub Projects

Expand Down
10 changes: 5 additions & 5 deletions addons/a11y/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-a11y",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "a11y addon for storybook",
"keywords": [
"a11y",
Expand Down Expand Up @@ -29,10 +29,10 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/client-logger": "4.0.0-rc.6",
"@storybook/components": "4.0.0-rc.6",
"@storybook/core-events": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/client-logger": "4.0.0",
"@storybook/components": "4.0.0",
"@storybook/core-events": "4.0.0",
"axe-core": "^3.1.2",
"global": "^4.3.2",
"prop-types": "^15.6.2"
Expand Down
8 changes: 4 additions & 4 deletions addons/actions/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-actions",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Action Logger addon for storybook",
"keywords": [
"storybook"
Expand All @@ -26,9 +26,9 @@
"@emotion/core": "^0.13.1",
"@emotion/provider": "^0.11.2",
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/components": "4.0.0-rc.6",
"@storybook/core-events": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/components": "4.0.0",
"@storybook/core-events": "4.0.0",
"deep-equal": "^1.0.1",
"global": "^4.3.2",
"lodash": "^4.17.11",
Expand Down
6 changes: 3 additions & 3 deletions addons/backgrounds/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-backgrounds",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "A storybook addon to show different backgrounds for your preview",
"keywords": [
"addon",
Expand Down Expand Up @@ -28,8 +28,8 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/core-events": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/core-events": "4.0.0",
"global": "^4.3.2",
"prop-types": "^15.6.2",
"util-deprecate": "^1.0.2"
Expand Down
2 changes: 1 addition & 1 deletion addons/centered/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-centered",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Storybook decorator to center components",
"keywords": [
"addon",
Expand Down
6 changes: 3 additions & 3 deletions addons/events/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-events",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Add events to your Storybook stories.",
"keywords": [
"addon",
Expand All @@ -27,8 +27,8 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/core-events": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/core-events": "4.0.0",
"format-json": "^1.0.3",
"prop-types": "^15.6.2",
"react-lifecycles-compat": "^3.0.4",
Expand Down
4 changes: 2 additions & 2 deletions addons/google-analytics/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-google-analytics",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Storybook addon for google analytics",
"keywords": [
"addon",
Expand All @@ -24,7 +24,7 @@
"prepare": "node ../../scripts/prepare.js"
},
"dependencies": {
"@storybook/addons": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"global": "^4.3.2",
"react-ga": "^2.5.3"
}
Expand Down
2 changes: 1 addition & 1 deletion addons/graphql/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-graphql",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Storybook addon to display the GraphiQL IDE",
"keywords": [
"addon",
Expand Down
8 changes: 4 additions & 4 deletions addons/info/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-info",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "A Storybook addon to show additional information for your stories.",
"keywords": [
"addon",
Expand All @@ -25,9 +25,9 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/client-logger": "4.0.0-rc.6",
"@storybook/components": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/client-logger": "4.0.0",
"@storybook/components": "4.0.0",
"core-js": "2.5.7",
"global": "^4.3.2",
"marksy": "^6.1.0",
Expand Down
6 changes: 3 additions & 3 deletions addons/jest/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-jest",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "React storybook addon that show component jest report",
"keywords": [
"addon",
Expand Down Expand Up @@ -31,8 +31,8 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/components": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/components": "4.0.0",
"global": "^4.3.2",
"prop-types": "^15.6.2",
"upath": "^1.1.0",
Expand Down
8 changes: 4 additions & 4 deletions addons/knobs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-knobs",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Storybook Addon Prop Editor Component",
"keywords": [
"addon",
Expand All @@ -25,9 +25,9 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/components": "4.0.0-rc.6",
"@storybook/core-events": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/components": "4.0.0",
"@storybook/core-events": "4.0.0",
"copy-to-clipboard": "^3.0.8",
"escape-html": "^1.0.3",
"fast-deep-equal": "^2.0.1",
Expand Down
8 changes: 4 additions & 4 deletions addons/links/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-links",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Story Links addon for storybook",
"keywords": [
"addon",
Expand All @@ -24,9 +24,9 @@
"prepare": "node ../../scripts/prepare.js"
},
"dependencies": {
"@storybook/addons": "4.0.0-rc.6",
"@storybook/components": "4.0.0-rc.6",
"@storybook/core-events": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"@storybook/components": "4.0.0",
"@storybook/core-events": "4.0.0",
"global": "^4.3.2",
"prop-types": "^15.6.2"
},
Expand Down
13 changes: 6 additions & 7 deletions addons/notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ import { storiesOf } from '@storybook/react';

import Component from './Component';

storiesOf('Component', module)
.add('with some emoji', () => <Component />, { notes: 'A very simple component' });
storiesOf('Component', module).add('with some emoji', () => <Component />, {
notes: 'A very simple component',
});
```

#### Using Markdown
Expand All @@ -51,9 +52,7 @@ import { storiesOf } from '@storybook/react';
import Component from './Component';
import someMarkdownText from './someMarkdownText.md';

storiesOf('Component', module).add(
'With Markdown',
() => <Component />,
{ notes: { markdown: someMarkdownText } }
);
storiesOf('Component', module).add('With Markdown', () => <Component />, {
notes: { markdown: someMarkdownText },
});
```
4 changes: 2 additions & 2 deletions addons/notes/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-notes",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Write notes for your Storybook stories.",
"keywords": [
"addon",
Expand All @@ -26,7 +26,7 @@
},
"dependencies": {
"@emotion/styled": "^0.10.6",
"@storybook/addons": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"marked": "^0.5.1",
"prop-types": "^15.6.2"
},
Expand Down
4 changes: 2 additions & 2 deletions addons/ondevice-backgrounds/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-ondevice-backgrounds",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "A storybook addon to show different backgrounds for your preview",
"keywords": [
"addon",
Expand All @@ -26,7 +26,7 @@
"prepare": "node ../../scripts/prepare.js"
},
"dependencies": {
"@storybook/addons": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"prop-types": "^15.6.2"
},
"peerDependencies": {
Expand Down
4 changes: 2 additions & 2 deletions addons/ondevice-knobs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@storybook/addon-ondevice-knobs",
"version": "4.0.0-rc.6",
"version": "4.0.0",
"description": "Display storybook story knobs on your deviced.",
"keywords": [
"addon",
Expand All @@ -23,7 +23,7 @@
"prepare": "node ../../scripts/prepare.js"
},
"dependencies": {
"@storybook/addons": "4.0.0-rc.6",
"@storybook/addons": "4.0.0",
"deep-equal": "^1.0.1",
"prop-types": "^15.6.2",
"react-native-color-picker": "^0.4.0",
Expand Down
8 changes: 5 additions & 3 deletions addons/ondevice-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Storybook Addon On Device Notes allows you to write notes (text or markdown) for
![Storybook Addon Notes Demo](docs/demo.png)

### Getting Started
**NOTE: Documentation on master branch is for alpha version, stable release is on [release/3.4](https://github.com/storybooks/storybook/tree/release/3.4/addons/)**

**NOTE: Documentation on master branch is for alpha version, stable release is on [release/4.0](https://github.com/storybooks/storybook/tree/release/4.0/addons/)**

```sh
yarn add -D @storybook/addon-ondevice-notes
Expand Down Expand Up @@ -43,6 +44,7 @@ import { storiesOf } from '@storybook/react-native';

import Component from './Component';

storiesOf('Component', module)
.add('with some emoji', () => <Component />, { notes: 'A very simple component' });
storiesOf('Component', module).add('with some emoji', () => <Component />, {
notes: 'A very simple component',
});
```
Loading

0 comments on commit a313e27

Please sign in to comment.