mirror of
https://github.com/storybookjs/storybook.git
synced 2025-03-20 05:02:37 +08:00
Update CONTRIBUTING notes, CHANGELOG format, skip "cleanup" labels
This commit is contained in:
Michael Shilman
parent
f45581cd43
commit
4329d58551
217
CHANGELOG.md
217
CHANGELOG.md
@ -1,131 +1,128 @@
|
||||
## 3.0.0 (May 27, 2017)
|
||||
### 3.0.0 (2017-05-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](FIXME), [docs](https://storybooks.js.org/)
|
||||
- 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
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Features
|
||||
10 PRs
|
||||
</summary>
|
||||
|
||||
* Added CRNA support (#1117)
|
||||
* [Addon-Knobs] Fixing performance issues. (#1039)
|
||||
* Allow HTTPS (#735)
|
||||
- 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)
|
||||
|
||||
</details>
|
||||
|
||||
#### Other
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Bug Fixes
|
||||
65 PRs
|
||||
</summary>
|
||||
|
||||
* FIX for test-cra was breaking the build (#972)
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
Maintenance
|
||||
</summary>
|
||||
- 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)
|
||||
|
||||
* FIX linting (#1132)
|
||||
* Fixed a typo in webpack.config.js (#1089)
|
||||
* refactor: change NPM organisation from kadira to storybook (#996)
|
||||
* CHANGE folder structure && CHANGE package-names (#1031)
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
Dependency Upgrades
|
||||
</summary>
|
||||
|
||||
* Update lerna to the latest version 🚀 (#1101)
|
||||
* update dependencies in cra-storybook (#1080)
|
||||
* Switch back to non-fork of react-inspector (#1026)
|
||||
* Dependency updates (#1008)
|
||||
* Update jest to the latest version 🚀 (#998)
|
||||
* CHANGE to use react-split-view 0.1.63 over the fork (#956)
|
||||
* FIX webpack overriding && CLEANUP && ADD example (#965)
|
||||
* Update lerna to the latest version 🚀 (#915)
|
||||
* Use jest for unittesting - standardize unit testing epic (#904)
|
||||
* Update dependencies to enable Greenkeeper 🌴 (#768)
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
Other
|
||||
</summary>
|
||||
|
||||
* Add travis deploy key (#1135)
|
||||
* ADD a global to storyshots to make it work for series with info addon (#1129)
|
||||
* Removed unsafe Storyshots import (#1124)
|
||||
* Update all package.json with monorepo metadata (#1111)
|
||||
* Add react-dom to the devDependency list for React Native projects (#1102)
|
||||
* Added `snapshotWithOptions` to allow configuring rendering options in Storyshots (#1090)
|
||||
* Upgrade React Native webpack config to webpack 2 (#1097)
|
||||
* Fix dead link to demo repository (#1091)
|
||||
* FIX postcss options missing && UPDATE dependencies (#1087)
|
||||
* fix(knobs): increase font size label (#1086)
|
||||
* CHANGE to prop-types package for notes & test-cra (#1082)
|
||||
* Configure snapshot test (#1035)
|
||||
* Test storyshots (#971)
|
||||
* IMPROVE cli (#1079)
|
||||
* Update package.json with repository info (#1078)
|
||||
* Update storyshots README.md example (#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 (#1030)
|
||||
* Upgraded webpack PostCSS plugin definition (#1062)
|
||||
* Update link to Storyshots addon (#1074)
|
||||
* chore(jest): update to v20's default configuration file (#1063)
|
||||
* Added error message for missing or invalid storyName (#747)
|
||||
* Removed `>` typo in Info prop table header (#1064)
|
||||
* Activating Open Collective (#1065)
|
||||
* 1052-resolve-output-path (#1058)
|
||||
* MOVE & RENAME and storyshots && CHANGE “React Storybook” > “Storybook” (#1044)
|
||||
* Update README (#1043)
|
||||
* Deprecate builtin addons (#1038)
|
||||
* Updated issue triage guidelines (#1024)
|
||||
* Deprecate built-in addons (#1025)
|
||||
* Add addonlinks repo (#1021)
|
||||
* Add propTablesExclude option (#924)
|
||||
* Add typescript definition to addon-notes (#989)
|
||||
* Fixes for types for knobs `number` (#1001)
|
||||
* Fix linting in addon-info (#980)
|
||||
* First pass at update the contribution instructions (#982)
|
||||
* Remove text transform uppercase for knob labels (#991)
|
||||
* Update links in PRs section of CONTRIBUTING.md (#992)
|
||||
* Updated dead getstorybook.io links to storybooks.js.org (#988)
|
||||
* Do not ignore story.js in prepublish (#973)
|
||||
* Fix typo in README (#977)
|
||||
* addon-info: make the info overlay be fixed (#914)
|
||||
* Fixing link (#974)
|
||||
* Update lerna to the latest version 🚀 (#969)
|
||||
* Handle null elements in getData (#926)
|
||||
* add description field from __docgenInfo for prop table for info plugin (#929)
|
||||
* #959 add a max-height and center element with alignItems: center (#961)
|
||||
* Switch to the only prepublish script (#903)
|
||||
* PR review policy (#923)
|
||||
* Add typescript definitions for getStorybook() (#753)
|
||||
* Restore deep link for addon docs (#919)
|
||||
* Fix default storybook webpack config (#922)
|
||||
* Render the first story for a kind if no story selected. (#918)
|
||||
* Update docs for monorepo (#913)
|
||||
* Monorepo readme and contributing (#907)
|
||||
* Add story kind regex (#906)
|
||||
* Add examples (#897)
|
||||
* Add missing repos (#882)
|
||||
* Switch to monorepo (#749)
|
||||
* extend devMiddlewareOptions with config.devServer (#723)
|
||||
* Added meta IE=edge (#715)
|
||||
* Replace String.includes with String.indexOf: cross-browsing support (#712)
|
||||
* Issue Triage instructions (#748)
|
||||
* Simple pull request template (#741)
|
||||
* Make return type of StoryDecorator nullable (#680)
|
||||
* Warn if story with a given name already exists (#670)
|
||||
* Fix spelling mistake - "element form the story" to "element from the story" (#702)
|
||||
* Remove broken react-button example (#699)
|
||||
* Fixed spelling error. (#720)
|
||||
* Typo fix (#671)
|
||||
* Cleaner error handling for storiesOf (#672)
|
||||
* Update links to point to new organization (#721)
|
||||
</details>
|
||||
|
||||
### v2.35.3
|
||||
|
||||
@ -176,16 +176,48 @@ Each release is described by:
|
||||
- A list of merged pull requests
|
||||
- Optionally, a short hand-written description
|
||||
|
||||
Thus current the release sequence is:
|
||||
Thus, the current release sequence is as follows:
|
||||
|
||||
1. Go to `master` and make sure you current with origin
|
||||
2. For full releases (i.e. not alpha/beta/rc), run `npm changelog` to update `CHANGELOG.md`.
|
||||
- Edit PR titles/labels on github until you're happy with the output in `CHANGELOG.md`.
|
||||
- Optionally, edit a handwritten description in `CHANGELOG.md`.
|
||||
3. `git clean -fdx && yarn` to clean out any extra files in your local directory (WARNING: destructive if you have extra files lying around!)
|
||||
4. `npm run bootstrap` to build all the packages
|
||||
5. `npm run publish -- --concurrency 1` to publish an alpha release
|
||||
- For a prerelease (alpha/beta/rc), add e.g. `--npm-tag=alpha` to the publish args
|
||||
6. Push the tag and `CHANGELOG.md` changes to github `git push --tags`
|
||||
**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.**
|
||||
|
||||
NOTE: we hope to automate this in CI at some point, 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 changelog
|
||||
|
||||
# tag the release and push `CHANGELOG.md` and tags
|
||||
# FIXME!!
|
||||
```
|
||||
|
||||
11
package.json
11
package.json
@ -65,13 +65,14 @@
|
||||
"url": "https://opencollective.com/storybook"
|
||||
},
|
||||
"pr-log": {
|
||||
"skipLabels": ["cleanup"],
|
||||
"validLabels": {
|
||||
"bug": "Bug Fixes",
|
||||
"greenkeeper": "Dependency Upgrades",
|
||||
"documentation": "Documentation",
|
||||
"feature": "Features",
|
||||
"maintenance": "Maintenance",
|
||||
"breaking": "Breaking Changes",
|
||||
"feature": "Features",
|
||||
"bug": "Bug Fixes",
|
||||
"documentation": "Documentation",
|
||||
"maintenance": "Maintenance",
|
||||
"greenkeeper": "Dependency Upgrades",
|
||||
"misc": "Other"
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user