diff --git a/app/react/CHANGELOG.md b/CHANGELOG.md similarity index 73% rename from app/react/CHANGELOG.md rename to CHANGELOG.md index d4f2a75bd0c7..d9b0b6817910 100644 --- a/app/react/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,137 @@ -## Changelog - -### v2.35.3 +# 3.0.0 + +2017-May-27 + +Storybook 3.0 is our first fully community-driven release! Notable changes: +- Moved from `@kadira` to `@storybooks` org across [github](https://github.com/storybooks/storybook/), [npm](https://www.npmjs.com/package/@storybook/react), [docs](https://storybook.js.org/) +- Upgraded to Webpack2! https://github.com/storybooks/storybook/pull/637 +- Switched to monorepo and overhauled package structure. https://github.com/storybooks/storybook/pull/749 https://github.com/storybooks/storybook/pull/1031 +- Added configuration options to storybooks snapshot testing. https://github.com/storybooks/storybook/pull/1090 +- Added `create-react-native-app` support. https://github.com/storybooks/storybook/pull/1117 +- Added HTTPS support. https://github.com/storybooks/storybook/pull/735 + +This is a major release with breaking changes. See our [migration guide](https://github.com/storybooks/storybook/blob/master/MIGRATION.md) for details. + +#### Features + +- Added CRNA support (#1117) +- [Addon-Knobs] Fixing performance issues. (#1039) +- Allow HTTPS (#735) + +#### Bug Fixes + +- FIX for test-cra was breaking the build (#972) + +#### Documentation + +- adds ReactSVGPanZoom to examples list (#1139) +- docs(custom-webpack-config): rules not loaders (#1137) + +#### Maintenance + +- refactor: change NPM organisation from kadira to storybook (#996) +- CHANGE folder structure && CHANGE package-names (#1031) + +#### Dependency Upgrades + +
+ +10 PRs + + +- Update lerna to the latest version 🚀 (https://github.com/storybooks/storybook/pulls/1101) +- update dependencies in cra-storybook (https://github.com/storybooks/storybook/pulls/1080) +- Switch back to non-fork of react-inspector (https://github.com/storybooks/storybook/pulls/1026) +- Dependency updates (https://github.com/storybooks/storybook/pulls/1008) +- Update jest to the latest version 🚀 (https://github.com/storybooks/storybook/pulls/998) +- CHANGE to use react-split-view 0.1.63 over the fork (https://github.com/storybooks/storybook/pulls/956) +- FIX webpack overriding && CLEANUP && ADD example (https://github.com/storybooks/storybook/pulls/965) +- Update lerna to the latest version 🚀 (https://github.com/storybooks/storybook/pulls/915) +- Use jest for unittesting - standardize unit testing epic (https://github.com/storybooks/storybook/pulls/904) +- Update dependencies to enable Greenkeeper 🌴 (https://github.com/storybooks/storybook/pulls/768) + +
+ +#### Other + +
+ +65 PRs + + +- Add travis deploy key (https://github.com/storybooks/storybook/pulls/1135) +- ADD a global to storyshots to make it work for series with info addon (https://github.com/storybooks/storybook/pulls/1129) +- Removed unsafe Storyshots import (https://github.com/storybooks/storybook/pulls/1124) +- Update all package.json with monorepo metadata (https://github.com/storybooks/storybook/pulls/1111) +- Add react-dom to the devDependency list for React Native projects (https://github.com/storybooks/storybook/pulls/1102) +- Added `snapshotWithOptions` to allow configuring rendering options in Storyshots (https://github.com/storybooks/storybook/pulls/1090) +- Upgrade React Native webpack config to webpack 2 (https://github.com/storybooks/storybook/pulls/1097) +- Fix dead link to demo repository (https://github.com/storybooks/storybook/pulls/1091) +- FIX postcss options missing && UPDATE dependencies (https://github.com/storybooks/storybook/pulls/1087) +- fix(knobs): increase font size label (https://github.com/storybooks/storybook/pulls/1086) +- CHANGE to prop-types package for notes & test-cra (https://github.com/storybooks/storybook/pulls/1082) +- Configure snapshot test (https://github.com/storybooks/storybook/pulls/1035) +- Test storyshots (https://github.com/storybooks/storybook/pulls/971) +- IMPROVE cli (https://github.com/storybooks/storybook/pulls/1079) +- Update package.json with repository info (https://github.com/storybooks/storybook/pulls/1078) +- Update storyshots README.md example (https://github.com/storybooks/storybook/pulls/1076) +- Added component description from __docgenInfo, Added the ability to get the PropType from __docgenInfo for prop table, Fixed an issue with PropVal rendering an object (https://github.com/storybooks/storybook/pulls/1030) +- Upgraded webpack PostCSS plugin definition (https://github.com/storybooks/storybook/pulls/1062) +- Update link to Storyshots addon (https://github.com/storybooks/storybook/pulls/1074) +- chore(jest): update to v20's default configuration file (https://github.com/storybooks/storybook/pulls/1063) +- Added error message for missing or invalid storyName (https://github.com/storybooks/storybook/pulls/747) +- Activating Open Collective (https://github.com/storybooks/storybook/pulls/1065) +- 1052-resolve-output-path (https://github.com/storybooks/storybook/pulls/1058) +- MOVE & RENAME and storyshots && CHANGE “React Storybook” > “Storybook” (https://github.com/storybooks/storybook/pulls/1044) +- Deprecate builtin addons (https://github.com/storybooks/storybook/pulls/1038) +- Updated issue triage guidelines (https://github.com/storybooks/storybook/pulls/1024) +- Deprecate built-in addons (https://github.com/storybooks/storybook/pulls/1025) +- Add addonlinks repo (https://github.com/storybooks/storybook/pulls/1021) +- Add propTablesExclude option (https://github.com/storybooks/storybook/pulls/924) +- Add typescript definition to addon-notes (https://github.com/storybooks/storybook/pulls/989) +- Fixes for types for knobs `number` (https://github.com/storybooks/storybook/pulls/1001) +- First pass at update the contribution instructions (https://github.com/storybooks/storybook/pulls/982) +- Remove text transform uppercase for knob labels (https://github.com/storybooks/storybook/pulls/991) +- Update links in PRs section of CONTRIBUTING.md (https://github.com/storybooks/storybook/pulls/992) +- Updated dead getstorybook.io links to storybooks.js.org (https://github.com/storybooks/storybook/pulls/988) +- Do not ignore story.js in prepublish (https://github.com/storybooks/storybook/pulls/973) +- addon-info: make the info overlay be fixed (https://github.com/storybooks/storybook/pulls/914) +- Update lerna to the latest version 🚀 (https://github.com/storybooks/storybook/pulls/969) +- Handle null elements in getData (https://github.com/storybooks/storybook/pulls/926) +- add description field from __docgenInfo for prop table for info plugin (https://github.com/storybooks/storybook/pulls/929) +- #959 add a max-height and center element with alignItems: center (https://github.com/storybooks/storybook/pulls/961) +- Switch to the only prepublish script (https://github.com/storybooks/storybook/pulls/903) +- PR review policy (https://github.com/storybooks/storybook/pulls/923) +- Add typescript definitions for getStorybook() (https://github.com/storybooks/storybook/pulls/753) +- Restore deep link for addon docs (https://github.com/storybooks/storybook/pulls/919) +- Fix default storybook webpack config (https://github.com/storybooks/storybook/pulls/922) +- Render the first story for a kind if no story selected. (https://github.com/storybooks/storybook/pulls/918) +- Update docs for monorepo (https://github.com/storybooks/storybook/pulls/913) +- Monorepo readme and contributing (https://github.com/storybooks/storybook/pulls/907) +- Add story kind regex (https://github.com/storybooks/storybook/pulls/906) +- Add examples (https://github.com/storybooks/storybook/pulls/897) +- Add missing repos (https://github.com/storybooks/storybook/pulls/882) +- Switch to monorepo (https://github.com/storybooks/storybook/pulls/749) +- extend devMiddlewareOptions with config.devServer (https://github.com/storybooks/storybook/pulls/723) +- Added meta IE=edge (https://github.com/storybooks/storybook/pulls/715) +- Replace String.includes with String.indexOf: cross-browsing support (https://github.com/storybooks/storybook/pulls/712) +- Issue Triage instructions (https://github.com/storybooks/storybook/pulls/748) +- Simple pull request template (https://github.com/storybooks/storybook/pulls/741) +- Make return type of StoryDecorator nullable (https://github.com/storybooks/storybook/pulls/680) +- Warn if story with a given name already exists (https://github.com/storybooks/storybook/pulls/670) +- Fix spelling mistake - "element form the story" to "element from the story" (https://github.com/storybooks/storybook/pulls/702) +- Remove broken react-button example (https://github.com/storybooks/storybook/pulls/699) +- Fixed spelling error. (https://github.com/storybooks/storybook/pulls/720) +- Cleaner error handling for storiesOf (https://github.com/storybooks/storybook/pulls/672) +- Update links to point to new organization (https://github.com/storybooks/storybook/pulls/721) + +
+ +# v2.35.3 Allow customConfig to override devtool. [PR668](https://github.com/storybooks/react-storybook/pull/668) -### v2.35.2 +# v2.35.2 03-January-2017 @@ -12,11 +139,11 @@ Fixes issue [#601](https://github.com/storybooks/react-storybook/issues/601) whe This release comes with the updated `babel-plugin-react-docgen`. -### v2.35.1 +# v2.35.1 - Revert [PR653](https://github.com/storybooks/react-storybook/pull/653) where it's causing HMR to not working properly. -### v2.35.0 +# v2.35.0 18-December-2016 @@ -24,90 +151,90 @@ This release comes with the updated `babel-plugin-react-docgen`. - Update css-loader dependency [PR648](https://github.com/storybooks/react-storybook/pull/648) - Check if stories are loaded from Jest [PR644](https://github.com/storybooks/react-storybook/pull/644) -### v2.34.0 +# v2.34.0 05-December-2016 Open the express router for developers (middleware.js file). [PR435](https://github.com/storybooks/react-storybook/pull/435) -### v2.33.1 +# v2.33.1 01-December-2016 Update Typescript definition file for global addDecorator. [PR634](https://github.com/storybooks/react-storybook/pull/634) -### v2.33.0 +# v2.33.0 28-November-2016 Completely avoid re-rendering the preview iframe. [PR631](https://github.com/storybooks/react-storybook/pull/631) -### v2.32.2 +# v2.32.2 28-November-2016 Update postmsg channel module version [PR627](https://github.com/storybooks/react-storybook/pull/627) -### v2.32.1 +# v2.32.1 22-November-2016 Add support for react_perf comes with React 15.4.0. [PR623](https://github.com/storybooks/react-storybook/pull/623) -### v2.32.0 +# v2.32.0 Incorrect publish (error when running `npm publish`) -### v2.31.0 +# v2.31.0 20-November-2016 Add the react-storybook version to the build output. [PR621](https://github.com/storybooks/react-storybook/pull/621) -### v2.30.1 +# v2.30.1 17-November-2016 Update the postmsg channel module to fix issue [#555](https://github.com/storybooks/react-storybook/issues/555) with [PR611](https://github.com/storybooks/react-storybook/pull/611) -### v2.30.0 +# v2.30.0 16-November-2016 Update to the new Storybook UI which doesn't use Redux. -### v2.29.7 +# v2.29.7 11-November-2016 Update @kadira/storybook-ui to the latest. -### v2.29.6 +# v2.29.6 10-November-2016 Fix a typo in the story syntax error messages. [PR610](https://github.com/storybooks/react-storybook/pull/610) -### v2.29.5 +# v2.29.5 09-November-2016 Check if regex and regex.test is available before calling it. [PR608](https://github.com/storybooks/react-storybook/pull/608) -### v2.29.3 +# v2.29.3 08-November-2016 Update webpack-hot-middleware to version 2.13.2 to fix the issue [#543](https://github.com/storybooks/react-storybook/issues/543). -### v2.29.3 +# v2.29.3 03-November-2016 Fix a regression caused by v2.29.2. There was a text called undefined listed always on the top of the preview. -### v2.29.2 +# v2.29.2 03-November-2016 @@ -119,33 +246,33 @@ Add various fixes. - Update postcss-loader to v1.1.0 [PR599](https://github.com/storybooks/react-storybook/pull/599) - fix for `module.hot` is not available in a static build [PR600](https://github.com/storybooks/react-storybook/pull/600) -### v2.29.1 +# v2.29.1 03-November-2016 Update babel-plugin-react-docgen to v1.4.1 to fix HOC [issue](https://github.com/kadirahq/babel-plugin-react-docgen/issues/19) -### v2.29.0 +# v2.29.0 01-November-2016 Update babel-plugin-react-docgen to 1.4.0. This will fix some of the compilation issues such as #580. -### v2.28.1 +# v2.28.1 28-October-2016 Remove preview decorator support. [PR583](https://github.com/storybooks/react-storybook/pull/583). -### v2.28.0 +# v2.28.0 28-October-2016 Add preview decorator support. [PR582](https://github.com/storybooks/react-storybook/pull/582). This will help us bring storybook designer with some great power. -### v2.27.0 +# v2.27.0 27-October-2016 @@ -157,7 +284,7 @@ Add a few usability improvements to Storybook. - Update `babel-preset-react-app` to the latest. [PR576](https://github.com/storybooks/react-storybook/pull/576) - Ship `json-loader` by default. [PR575](https://github.com/storybooks/react-storybook/pull/575) -### v2.26.0 +# v2.26.0 24-October-2016 @@ -167,13 +294,13 @@ Get some new features from CRA. - Allow to use postcss for CSS @imports [PR564](https://github.com/storybooks/react-storybook/pull/564) - Use process.env as a proper object [PR565](https://github.com/storybooks/react-storybook/pull/565) -### v2.25.1 +# v2.25.1 23-October-2016 Add a potential fix to [558](https://github.com/storybooks/react-storybook/issues/558) by updating babel-plugin-react-docgen to the latest(v1.3.2). -### v2.25.0 +# v2.25.0 21-October-2016 @@ -185,25 +312,25 @@ With this: Additionally, added `yarn.lock`. -### v2.24.1 +# v2.24.1 19-October-2016 Do not show git command output. [PR554](https://github.com/storybooks/react-storybook/pull/554) -### v2.24.0 +# v2.24.0 07-October-2016 - Export git repository info to support custom tool integrations [PR536](https://github.com/storybooks/react-storybook/pull/536) -### v2.23.0 +# v2.23.0 06-October-2016 - Remove the experimental database addon from react-storybook [PR535](https://github.com/storybooks/react-storybook/pull/535) -### v2.22.0 +# v2.22.0 05-October-2016 @@ -212,80 +339,80 @@ Add some nice development experiment based on suggestion from Dan Abramov. - Set a color to the Storybook URL in the console. [PR533](https://github.com/storybooks/react-storybook/pull/533) - Add better error message when there's no React element in the story. [PR534](https://github.com/storybooks/react-storybook/pull/534) -### v2.21.0 +# v2.21.0 05-October-2016 - Get the latest features from CRA including NODE_PATH support, public folder support and some other minor changes. [#468](https://github.com/storybooks/react-storybook/issues/468) - Also bumped `@kadira/storybook-channel-postmsg` to `^1.0.3` -### v2.20.1 +# v2.20.1 28-September-2016 - Fix story kind order bug [PR499](https://github.com/storybooks/react-storybook/pull/499) - Prefix config environment variables [PR503](https://github.com/storybooks/react-storybook/pull/503) -### v2.20.0 +# v2.20.0 26-September-2016 - Use postMessage channel [PR498](https://github.com/storybooks/react-storybook/pull/498) - Support dynamic panel titles [PR497](https://github.com/storybooks/react-storybook/pull/497) -### v2.19.0 +# v2.19.0 26-September-2016 - Support layout options [PR494](https://github.com/storybooks/react-storybook/pull/494) - Update Typescript definitions [PR491](https://github.com/storybooks/react-storybook/pull/491) and [PR493](https://github.com/storybooks/react-storybook/pull/493) -### v2.18.1 +# v2.18.1 23-September-2016 - Stop uglifyjs from mangling names [PR483](https://github.com/storybooks/react-storybook/pull/483) -### v2.18.0 +# v2.18.0 23-September-2016 - Remove `STORYBOOK_` prefix from config env [PR481](https://github.com/storybooks/react-storybook/pull/481) -### v2.17.0 +# v2.17.0 22-September-2016 - Add support for StoryShots. [PR479](https://github.com/storybooks/react-storybook/pull/479) - Fix some typos: [PR477](https://github.com/storybooks/react-storybook/pull/477) & [PR478](https://github.com/storybooks/react-storybook/pull/478) -### v2.16.1 +# v2.16.1 21-September-2016 - Fix the 404 error for `addon-db.json` file [PR472](https://github.com/storybooks/react-storybook/pull/472) - Serve/Bundle the storybook favicon [PR473](https://github.com/storybooks/react-storybook/pull/473) -### v2.16.0 +# v2.16.0 21-September-2016 - Move the babel config loading logic into a seperate file. [PR469](https://github.com/storybooks/react-storybook/pull/469) - Update airbnd eslint rules to the latest. -### v2.15.1 +# v2.15.1 19-September-2016 Add a fix to webpack custom resolve.alias not working. [PR465](https://github.com/storybooks/react-storybook/pull/465) -### v2.15.0 +# v2.15.0 19-September-2016 - Use @kadira/storybook-addons as a resolve.alias. So, we can support addons for NPM2 too. [PR462](https://github.com/storybooks/react-storybook/pull/462) -### v2.14.0 +# v2.14.0 14-September-2016 @@ -294,26 +421,26 @@ Add a fix to webpack custom resolve.alias not working. [PR465](https://github.co - Allow to reload if HMR goes crazy. [PR448](https://github.com/storybooks/react-storybook/pull/448) - Add support to get custom env variables. [PR450](https://github.com/storybooks/react-storybook/pull/450) -### v2.13.1 +# v2.13.1 14-September-2016 - Fix 404 error when db file does not exist [PR449](https://github.com/storybooks/react-storybook/pull/449) -### v2.13.0 +# v2.13.0 9-September-2016 - Fix [#443](https://github.com/storybooks/react-storybook/issues/443) where the static version of Storybook doesn't like Safari. - Update postcss-loader to 0.13.0. -### v2.12.1 +# v2.12.1 8-September-2016 - Parse static directory provided by env as a list. [PR436](https://github.com/storybooks/react-storybook/pull/436) -### v2.12.0 +# v2.12.0 8-September-2016 @@ -321,86 +448,86 @@ Add a fix to webpack custom resolve.alias not working. [PR465](https://github.co - Update css-loader to version 0.25.0. [PR427](https://github.com/storybooks/react-storybook/pull/427) - Get the head.html values for every page request. [PR432](https://github.com/storybooks/react-storybook/pull/432) -### v2.11.0 +# v2.11.0 4-September-2016 - Remove babel-polyfill since we don't use it. - Update versions with the help from greenkeeper. [PR421](https://github.com/storybooks/react-storybook/pull/421) -### v2.10.0 +# v2.10.0 3-September-2016 - Adding airbnb-js-shims again. [PR419](https://github.com/storybooks/react-storybook/pull/419) -### v2.9.1 +# v2.9.1 2-September-2016. - Use the config directory to store the addon database file [PR418](https://github.com/storybooks/react-storybook/pull/418). -### v2.9.0 +# v2.9.0 2-September-2016. - Copy the addon-db.json file when building static storybooks [PR417](https://github.com/storybooks/react-storybook/pull/417). -### v2.8.0 +# v2.8.0 2-September-2016. - Update @kadira/storybook to get the clean query params feature. See [storybook-ui-PR37](https://github.com/kadirahq/storybook-ui/pull/37) -### v2.7.0 +# v2.7.0 1-September-2016 - Add addon database feature [PR415](https://github.com/storybooks/react-storybook/pull/415). -### v2.6.1 +# v2.6.1 31-August-2016 - Bring back HMR dev logs. [PR412](https://github.com/storybooks/react-storybook/pull/412). -### v2.6.0 +# v2.6.0 30-August-2016 - Allow start/build params from env variables. [PR413](https://github.com/storybooks/react-storybook/pull/413) -### v2.5.2 +# v2.5.2 29-August-2016 - Remove the use of babel-runtime/core-js modules. [PR410](https://github.com/storybooks/react-storybook/pull/410) -### v2.5.1 +# v2.5.1 24-August-2016 - Update @kadira/storybook-ui to v3.3.2 -### v2.5.0 +# v2.5.0 24-August-2016 - We are no longer shipping extra polyfills anymore. [PR402](https://github.com/storybooks/react-storybook/pull/402) -### v2.4.2 +# v2.4.2 24-August-2016 - Allow file-loader URLs to work on subpaths. [PR401](https://github.com/storybooks/react-storybook/pull/401) -### v2.4.1 +# v2.4.1 24-August-2016 - Bump @kadira/storybook ui to v3.3.1 to fix some UI related issues. -### v2.4.0 +# v2.4.0 23-August-2016 @@ -409,32 +536,32 @@ Add a fix to webpack custom resolve.alias not working. [PR465](https://github.co - Add webpack2 support by changing the use of OccurenceOrderPlugin. [PR397](https://github.com/storybooks/react-storybook/pull/397) - Use @kadira/storybook-ui 2.3.0, which has new APIs to set URL for addons. -### v2.3.0 +# v2.3.0 16-August-2016 - Implement anonymous usage tracking. [PR384](https://github.com/storybooks/react-storybook/pull/384) -### v2.2.3 +# v2.2.3 15-August-2016 - Add a hash to media file's filename. Otherwise, it'll cause issues when there are multiple images with the same filename but in different directories. [PR380](https://github.com/storybooks/react-storybook/pull/380) -### v2.2.2 +# v2.2.2 10-August-2016 - Remove unused extract-text-webpack-plugin. This will add webpack2 support. [PR369](https://github.com/storybooks/react-storybook/pull/369). -### v2.2.1 +# v2.2.1 09-August-2016 - Use @kadira/storybook-channel modules. [#PR359](https://github.com/storybooks/react-storybook/pull/359). - Update @kadira/storybook-ui to the latest. -### v2.2.0 +# v2.2.0 05-August-2016 @@ -445,7 +572,7 @@ This release bring some webpack config related optimizations and the NPM2 suppor - Add NPM2 support. [PR356](https://github.com/storybooks/react-storybook/pull/356) - Add autofixer defaults. [PR357](https://github.com/storybooks/react-storybook/pull/357) -### v2.1.1 +# v2.1.1 03-August-2016 @@ -454,7 +581,7 @@ Remove default webpack config for all config types. [PR348](https://github.com/s Now we only use the Create React App based config if there's no custom webpack config. This will fix issues like [#347](https://github.com/storybooks/react-storybook/issues/347). -### v2.1.0 +# v2.1.0 02-August-2016 @@ -470,7 +597,7 @@ Unfortunately, as of this version, there are no docs for this feature. But, you Have a look at [here](https://github.com/storybooks/react-storybook/blob/master/src/server/config.js#L88) to how to configure addons. -### v2.0.0 +# v2.0.0 01-August-2016 @@ -484,151 +611,151 @@ This is the starting of the next major version of Storybook. This version is alm - Continue support for babel's stage-0 preset and add es2016 preset. - Update @kadira/storybook-ui to v2.6.1 to remove some React warnings. -### v1.41.0 +# v1.41.0 - Fix nodejs require errors [#337](https://github.com/storybooks/react-storybook/pull/337). - Add getStorybook method to client API [#332](https://github.com/storybooks/react-storybook/pull/332). -### v1.40.0 +# v1.40.0 - Fix duplicate decorator bug [#335](https://github.com/storybooks/react-storybook/pull/335). -### v1.39.1 +# v1.39.1 - Update babel packages [#325](https://github.com/storybooks/react-storybook/pull/325). - Hide HMR info logs [#331](https://github.com/storybooks/react-storybook/pull/331). -### v1.39.0 +# v1.39.0 - Update @kadira/storybook-ui to get features from [v2.5.0](https://github.com/kadirahq/storybook-ui/blob/master/CHANGELOG.md#v250) and [v2.6.0](https://github.com/kadirahq/storybook-ui/blob/master/CHANGELOG.md#v260). -### v1.38.3 +# v1.38.3 - Add names for action and linkTo functions [#321](https://github.com/storybooks/react-storybook/pull/321). -### v1.38.2 +# v1.38.2 - Fix error in prepublish script [#319](https://github.com/storybooks/react-storybook/pull/319). -### v1.38.1 +# v1.38.1 - Improve Windows support by writing prepublish script using shelljs [#308](https://github.com/storybooks/react-storybook/pull/308). -### v1.38.0 +# v1.38.0 - v1.37.0 was a nightmare since it contains the npm-shrinkwrap.json. Fixed by removing it. See: [#306](https://github.com/storybooks/react-storybook/issues/306) and [#305](https://github.com/storybooks/react-storybook/pull/305). -### v1.37.0 +# v1.37.0 - Update @kadira/storybook-ui to 2.4.0 -### v1.36.0 +# v1.36.0 - Support watchOptions configuration. See: [PR287](https://github.com/storybooks/react-storybook/pull/287) -### v1.35.2 +# v1.35.2 - Add missing font-face to the ErrorDisplay's heading. -### v1.35.1 +# v1.35.1 - Fix issue related to bad error handling. See issue [#275](https://github.com/storybooks/react-storybook/issues/275): -### v1.35.0 +# v1.35.0 - Add fuzzy search powered search box and Redux DevTools support via [@kadira/storybook-ui@2.3.0](https://github.com/kadirahq/storybook-ui/blob/master/CHANGELOG.md#v230). -### v1.34.1 +# v1.34.1 - Don't always override NODE_ENV in build-storybook. [PR272](https://github.com/storybooks/react-storybook/pull/272) -### v1.34.0 +# v1.34.0 - Use storybook-ui v2.2.0 which puts shortcut state into the URL. -### v1.33.0 +# v1.33.0 - Introduce an [extension API](https://github.com/storybooks/react-storybook/blob/master/docs/extensions.md) for Storybook. See: [PR258](https://github.com/storybooks/react-storybook/pull/258) -### v1.32.1 +# v1.32.1 - Extend @kadira/storybook-ui provider from it's base Provider. -### v1.32.0 +# v1.32.0 - Use @kadira/storybook-ui as the manager UI with the implemented provider for React. See `client/manager` for more info. -### v1.31.0 +# v1.31.0 - Pass a `context` argument to stories [PR250](https://github.com/storybooks/react-storybook/pull/250) -### v1.30.0 +# v1.30.0 - Fuzzy search kinds [PR247](https://github.com/storybooks/react-storybook/pull/247) -### v1.29.5 +# v1.29.5 - Update dependency version to fix filter crash [PR246](https://github.com/storybooks/react-storybook/pull/246) -### v1.29.4 +# v1.29.4 - Protect index.html/iframe.html from being overwritten [PR243](https://github.com/storybooks/react-storybook/pull/243) -### v1.29.3 +# v1.29.3 - Update @kadira/storybook-core version [PR241](https://github.com/storybooks/react-storybook/pull/241) - Add es6-shim by default [PR238](https://github.com/storybooks/react-storybook/pull/238) -### v1.29.2 +# v1.29.2 - Use url.resolve instead of path.join [PR240](https://github.com/storybooks/react-storybook/pull/240) -### v1.29.1 +# v1.29.1 - Copy missed manager.js.map file on static build [PR236](https://github.com/storybooks/react-storybook/pull/236) -### v1.29.0 +# v1.29.0 - Multiple static dirs (comma separated) [PR229](https://github.com/storybooks/react-storybook/pull/229) -### v1.28.5 +# v1.28.5 - Support ECMAScript stage-0 [PR228](https://github.com/storybooks/react-storybook/pull/228) to fix [Issue #227](https://github.com/storybooks/react-storybook/issues/227) -### v1.28.4 +# v1.28.4 - Support custom webpack public path for dev-server and static build started by [PR226](https://github.com/storybooks/react-storybook/pull/226) -### v1.28.3 +# v1.28.3 - Revert [PR226](https://github.com/storybooks/react-storybook/pull/226) -### v1.28.2 +# v1.28.2 - Support custom webpack publicPath [PR226](https://github.com/storybooks/react-storybook/pull/226) -### v1.28.1 +# v1.28.1 - Add charset meta tags to HTML heads [PR216](https://github.com/storybooks/react-storybook/pull/216) -### v1.28.0 +# v1.28.0 - Moved storybook serving code into a middleware to support more advanced use cases. - Refactored dev server to use storybook middleware [PR211](https://github.com/storybooks/react-storybook/pull/211) -### v1.27.0 +# v1.27.0 - Move modules to storybook-core repo. [PR196](https://github.com/storybooks/react-storybook/pull/196) - Add stack-source-map again only for Chrome to get better error stacks. - Add ability to control the hostname. See [PR195](https://github.com/storybooks/react-storybook/pull/195) and [PR198](https://github.com/storybooks/react-storybook/pull/198) -### v1.26.0 +# v1.26.0 12-May-2016 - Ensure asset directory exists in the static-builder. -### v1.25.0 +# v1.25.0 11-May-2016 @@ -640,7 +767,7 @@ This is the starting of the next major version of Storybook. This version is alm - Make left panel scrollable with keeping the filterbox always. See: [PR182](https://github.com/storybooks/react-storybook/pull/182). - Add `qs` as a direct dependency as it's used in preview. -### v1.24.0 +# v1.24.0 10-May-2016 @@ -648,34 +775,34 @@ This is the starting of the next major version of Storybook. This version is alm - Add scrolling support to the left panel. Fixes [#177](https://github.com/storybooks/react-storybook/issues/177). - Remove NODE_ENV=production flag. Fixes [#158](https://github.com/storybooks/react-storybook/issues/158) -### v1.23.0 +# v1.23.0 09-May-2016 - Add shortcuts to jump to previous and next stories. See [PR176](https://github.com/storybooks/react-storybook/pull/176) - Fix loader concatenation bug specially when custom config doesn't have a loaders section. [PR173](https://github.com/storybooks/react-storybook/pull/173) -### v1.22.1 +# v1.22.1 06-May-2016 - Add a potential fix for [#167](https://github.com/storybooks/react-storybook/issues/167) - basically, this moved back babel-packages required by webpack. -### v1.22.0 +# v1.22.0 06-May-2016 - Improve the static builder time. -### v1.21.0 +# v1.21.0 06-May-2016 - Add configType argument to custom config function. See: [PR169](https://github.com/storybooks/react-storybook/pull/169) - Add the unicode version of the Keyboard Shortcut Icon. See: [PR170](https://github.com/storybooks/react-storybook/pull/170) -### v1.20.0 +# v1.20.0 05-May-2016 @@ -685,7 +812,7 @@ This is the starting of the next major version of Storybook. This version is alm - Remove some typo in docs. See: [PR154](https://github.com/storybooks/react-storybook/pull/154) - Move UI testing libraries to devDependencies. See: [PR153](https://github.com/storybooks/react-storybook/pull/153) -### v1.19.0 +# v1.19.0 27-April-2016 @@ -693,38 +820,38 @@ This is the starting of the next major version of Storybook. This version is alm - Remove self-closing div tag, which is invalid HTML. See: [PR148](https://github.com/storybooks/react-storybook/pull/148) - Search for a .babelrc in the storybook config directory first, then the project root. See: [PR149](https://github.com/storybooks/react-storybook/pull/149) -### v1.18.0 +# v1.18.0 26-April-2016 - Link Storybook menu to the repo. See: [PR137](https://github.com/storybooks/react-storybook/pull/137) - Implement keyboard shortcuts and fuzzy search. See: [PR141](https://github.com/storybooks/react-storybook/pull/141) -### v1.17.2 +# v1.17.2 25-April-2016 - Fix an error which only occurs on Firefox. See: [PR144](https://github.com/storybooks/react-storybook/pull/144) -### v1.17.1 +# v1.17.1 21-April-2016 - Fix a regression introduce by `v1.17.0`. See: [PR133](https://github.com/storybooks/react-storybook/pull/133) -### v1.17.0 +# v1.17.0 21-April-2016 - Check all the arguments passed to action for events. See: [PR132](https://github.com/storybooks/react-storybook/pull/132) -### v1.16.1 +# v1.16.1 21-April-2016 - Fix action logs highlighting issue, which comes as a regression of [PR126](https://github.com/storybooks/react-storybook/pull/126). -### v1.16.0 +# v1.16.0 20-April-2016 @@ -732,37 +859,37 @@ This is the starting of the next major version of Storybook. This version is alm - Related issue: [#116](https://github.com/storybooks/react-storybook/issues/116) - Related PR: [PR126](https://github.com/storybooks/react-storybook/pull/126) -### v1.15.0 +# v1.15.0 20-April-2016 - Improve action logger UI and increase max log count to 10. See [PR123](https://github.com/storybooks/react-storybook/pull/123) -### v1.14.0 +# v1.14.0 19-April-2016 - Add syntax highlights to the logger. See: [PR118](https://github.com/storybooks/react-storybook/pull/118) -### v1.13.0 +# v1.13.0 - Add some UI test cases. See [PR103](https://github.com/storybooks/react-storybook/pull/103) - Implement `.addDecorator()` API. See [PR115](https://github.com/storybooks/react-storybook/pull/115) - Add code folding support. See [PR111](https://github.com/storybooks/react-storybook/pull/111) -### v1.12.0 +# v1.12.0 14-April-2016 - Add support for webpack module preLoaders. See: [PR107](https://github.com/storybooks/react-storybook/pull/107) -### v1.11.0 +# v1.11.0 13-April-2016 - Add support for React DevTools. See: [PR104](https://github.com/storybooks/react-storybook/pull/104) -### v1.10.2 +# v1.10.2 12-April-2016 @@ -772,13 +899,13 @@ Fix various issues related to static bundling. - Use relative urls so, static sites can be host with paths (GH Pages) - Identify SyntheticEvent using feature detection. UglifyJS mangal class names, so we can't use classnames to detect a SyntheticEvent in the static build. -### v1.10.1 +# v1.10.1 - Don't serve index.html in static directory as a site index. See [PR100](https://github.com/storybooks/react-storybook/pull/100) - Use cjson for parsing .babelrc files (support comments). See [PR98](https://github.com/storybooks/react-storybook/pull/98) - Remove the dist directory before running babel to avoid older code. See [PR101](https://github.com/storybooks/react-storybook/pull/101) -### v1.10.0 +# v1.10.0 - Add custom head support inside the iframe. See [PR77](https://github.com/storybooks/react-storybook/pull/77) - Unmount components before rendering into DOM node. Fix: [#81](https://github.com/storybooks/react-storybook/issues/81) @@ -786,7 +913,7 @@ Fix various issues related to static bundling. - Fix search box's lineHeight to work with all the browsers. See: [PR94](https://github.com/storybooks/react-storybook/pull/94) - Add the search box. See: [PR91](https://github.com/storybooks/react-storybook/pull/91). -### v1.9.0 +# v1.9.0 Add some minor improvements. @@ -794,48 +921,48 @@ Add some minor improvements. - Fix the React Warning about CSS property. See: [PR84](https://github.com/storybooks/react-storybook/pull/84) - Transition on latest logged action. See: [PR80](https://github.com/storybooks/react-storybook/pull/80) -### v1.8.0 +# v1.8.0 - Add story linking functionality. - [Documentation](https://github.com/storybooks/react-storybook/blob/master/docs/api.md#linking-stories). - Original feature request: [#50](https://github.com/storybooks/react-storybook/issues/50) - Implementation: [PR86](https://github.com/storybooks/react-storybook/pull/86) -### v1.7.0 +# v1.7.0 - Add support to React v15.0.0. -### v1.6.0 +# v1.6.0 - Make scrollable layout. See: [PR](https://github.com/storybooks/react-storybook/pull/70) - Add npm3 requirement to the `package.json`. - Add `react` and `react-dom` to devDependencies. -### v1.5.0 +# v1.5.0 - Add support for most of the custom webpack configuration. See [PR64](https://github.com/storybooks/react-storybook/pull/64) -### v1.4.0 +# v1.4.0 - Add CLI option to specify the config dir. See [PR52](https://github.com/storybooks/react-storybook/pull/52). -### v1.3.0 +# v1.3.0 - Load the `.babelrc` manually. Fixed: [#41](https://github.com/storybooks/react-storybook/issues/41) - Add a better contributing guide. See [CONTRIBUTING.md](https://github.com/storybooks/react-storybook/blob/master/CONTRIBUTING.md) - Add a development utility `npm run dev` which watches "src" directory and run `npm run prepublish`. -### v1.2.0 +# v1.2.0 - Add a button to clear logs in the ActionLogger. This is requested in [PR21](https://github.com/storybooks/react-storybook/issues/21). - Remove navigation list order hijacking. See [commit](https://github.com/storybooks/react-storybook/commit/166365fd38f51f79e69e028a1c11e2620eddcb99). - Fix a typo in .gitignore. See [PR31](https://github.com/storybooks/react-storybook/pull/31). - Add support for JSX. See [PR18](https://github.com/storybooks/react-storybook/pull/18). -### v1.1.0 +# v1.1.0 - v1.0.0 was a mistake and it contains very old code. That's why we had to do a 1.1.0 release. -### v1.0.0 +# v1.0.0 - Yeah! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a26ef488bf14..ae2f3b531f11 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,3 +166,59 @@ npm link @storybook/react ### Getting Changes After you've done any change, you need to run the `npm run storybook` command every time to see those changes. + +## Release Guide + +This section is for Storybook maintainers who will be creating releases. + +Each release is described by: +- A version +- A list of merged pull requests +- Optionally, a short hand-written description + +Thus, the current release sequence is as follows: + +**NOTE: This is a work in progress. Don't try this unless you know what you're doing. We hope to automate this in CI, so this process is designed with that in mind.** + +First, build the release: + +```sh +# make sure you current with origin/master. +git checkout master +git status + +# clean out extra files +# WARNING: destructive if you have extra files lying around! +git clean -fdx && yarn + +# build all the packages +npm run bootstrap +``` + +From here there are different procedures for prerelease (e.g. alpha/beta/rc) and proper release. + +#### For prerelease (no CHANGELOG): + +```sh +# publish and tag the release +npm run publish -- --concurrency 1 --npm-tag=alpha + +# push the tags +git push --tags +``` + +#### For full release (with CHANGELOG): + +```sh +# publish but don't commit to git +npm run publish -- --concurrency 1 --skip-git + +# Update `CHANGELOG.md` +# - Edit PR titles/labels on github until output is good +# - Optionally, edit a handwritten description in `CHANGELOG.md` +npm run changelog + +# tag the release and push `CHANGELOG.md` and tags +# FIXME: not end-to-end tested! +npm run github-release +``` diff --git a/README.md b/README.md index dd4eb38ace75..96aed6c11448 100644 --- a/README.md +++ b/README.md @@ -72,8 +72,9 @@ For full documentation on using Storybook visit: [storybooks.js.org](https://sto ## Contributing -We welcome contributions to Storybook! There are many ways to contribute to -this project. [Get started here](CONTRIBUTING.md) +We welcome contributions to Storybook! +- ⇄ Pull requests and ★ Stars are always welcome. +- Read our [contributing guide](CONTRIBUTING.md) to get started. ### Development scripts diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 000000000000..cce6ae325535 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,14 @@ +# Roadmap + +### Short Term + +* Mobile support +* Addon API and addons +* A clear guide to hack Storybook +* React Native Support + +### Long Term + +* Automatic story generation (and edge case detection) based on propTypes. +* Angular Support +* Vue Support diff --git a/app/react/ROADMAP.md b/app/react/ROADMAP.md deleted file mode 100644 index dc282e22bfe6..000000000000 --- a/app/react/ROADMAP.md +++ /dev/null @@ -1,14 +0,0 @@ -# Roadmap - -### Short Term - -- Addon API and addons -- A clear guide to hack Storybook -- React Native Support - -### Long Term - -- Automatic story generation (and edge case detection) based on propTypes. -- Angular Support -- Vue Support -- UI addons (Add different panels like Action Logger) diff --git a/package.json b/package.json index 5939ffddd3c2..e324d1887c4b 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,9 @@ { "name": "storybook", + "repository": { + "type": "git", + "url": "git@github.com:storybooks/storybook.git" + }, "devDependencies": { "babel-cli": "^6.24.1", "babel-core": "^6.24.1", @@ -17,6 +21,7 @@ "eslint-plugin-jest": "^20.0.3", "eslint-plugin-prettier": "^2.1.1", "gh-pages": "^1.0.0", + "github-release-from-changelog": "^1.2.1", "jest": "^20.0.4", "jest-enzyme": "^3.2.0", "lerna": "2.0.0-rc.5", @@ -34,11 +39,9 @@ "remark-toc": "^4.0.0", "shelljs": "^0.7.7" }, - "repository": { - "type": "git", - "url": "git://github.com/storybooks/storybook.git" - }, "scripts": { + "changelog": "pr-log --sloppy", + "github-release": "github-release-from-changelog", "publish": "lerna publish", "import-repo": "lerna import", "bootstrap": "lerna bootstrap", @@ -58,5 +61,19 @@ "collective": { "type": "opencollective", "url": "https://opencollective.com/storybook" + }, + "pr-log": { + "skipLabels": [ + "cleanup" + ], + "validLabels": { + "breaking": "Breaking Changes", + "feature": "Features", + "bug": "Bug Fixes", + "documentation": "Documentation", + "maintenance": "Maintenance", + "greenkeeper": "Dependency Upgrades", + "other": "Other" + } } }