Skip to content

Commit

Permalink
Add 3.1.0 release notes and migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
shilman committed Jun 9, 2017
1 parent 96e99a3 commit 184711c
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 1 deletion.
36 changes: 36 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
# 3.1.0

Minor features including a new "events" addon, as well as the usual bugfixes, cleanup, etc.

2017-June-09

#### Features

- Add small design update to addon info package [#1213](https://github.com/storybooks/storybook/pull/1213)
- Add display configuration options to info addon [#1157](https://github.com/storybooks/storybook/pull/1157)
- Add support for multiple webpack chunks in iframe [#1083](https://github.com/storybooks/storybook/pull/1083)
- Add events addon [#1130](https://github.com/storybooks/storybook/pull/1130)

#### Bug Fixes

- Fixed knobs addon editing bug [#1233](https://github.com/storybooks/storybook/pull/1233)
- Fix bug in addons/graphql in reIndentQuery [#1207](https://github.com/storybooks/storybook/pull/1207)
- Marksy initialized with mtrcConf intead of marksyConf [#1205](https://github.com/storybooks/storybook/pull/1205)

#### Documentation

- Document stories not showing up on storybook UI until device connects [#1221](https://github.com/storybooks/storybook/pull/1221)
- Fixed references to storybook.js.org. [#1211](https://github.com/storybooks/storybook/pull/1211)
- Updated repository URL to address broken npm images [#1197](https://github.com/storybooks/storybook/pull/1197)

#### Maintenance

- Added a vanilla React Native example app. [#1202](https://github.com/storybooks/storybook/pull/1202)
- Move typings for @storybook/react to @types package [#1199](https://github.com/storybooks/storybook/pull/1199)
- Set ESlint rules more strict 🚑 [#911](https://github.com/storybooks/storybook/pull/911)

#### Dependency Upgrades

- Update babel docgen plugin to generate docs for React.createClass and createReactClass [#1206](https://github.com/storybooks/storybook/pull/1206)
- Update `marksy` dependecy due broken 1.1.0 version [#1204](https://github.com/storybooks/storybook/pull/1204)

# 3.0.1

Minor bug fixes and documentation updates post 3.0.0 release.
Expand Down
11 changes: 11 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@

## Table of contents

- [from version 3.0.x to 3.1.0](#from-version-30x-to-310)
- [from version 2.x.x to 3.x.x](#from-version-2xx-to-3xx)
- [Webpack upgrade](#webpack-upgrade)
- [Packages renaming](#packages-renaming)
- [Deprecated embedded addons](#deprecated-embedded-addons)

## from version 3.0.x to 3.1.0

Typescript users: we are in the process of moving our typescript definitions into [DefinitelyTyped](http://definitelytyped.org/). If you're using Typescript, starting in 3.1.0 you need to make sure your type definitions are installed:

```sh
npm install @types/node @types/react @types/storybook__react --save-dev
```

**NOTE:** technically this is a breaking change and should be a 4.0.0 release according to semver. However, we're still figuring things out, and didn't think this change necessitated a major release.

## from version 2.x.x to 3.x.x

This major release is mainly an internal restructuring.
Expand Down
1 change: 0 additions & 1 deletion docs/pages/configurations/add-custom-head-tags/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,3 @@ Create a file called `manager-head.html` inside of the Storybook config director
> **Important**
>
> Your scripts will run before Storybook's React UI. Also be aware, that this is an uncommon scenario and could potentially break Storybook's UI. So use with caution.

0 comments on commit 184711c

Please sign in to comment.