Skip to content

Commit 768962c

Browse files
author
parkerziegler
committed
Update CHANGELOG and README.
1 parent 399d7ec commit 768962c

File tree

2 files changed

+43
-5
lines changed

2 files changed

+43
-5
lines changed

CHANGELOG.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
1-
# Change Log
1+
# Changelog
22

33
This project adheres to [Semantic Versioning](http://semver.org/).
44
Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/FormidableLabs/webpack-dashboard/releases) page.
55

6+
## [3.0.4] - 2019-04-24
7+
8+
### Features
9+
10+
- Use `npm-run-all` as task runner for `package.json` scripts. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/283.
11+
- Use `test` in lieu of `test-summary` for `nyc` coverage reporting on command line. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/283.
12+
13+
### Security
14+
15+
- Address `handlebars` security vulnerability. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/282 by @juliusl.
16+
- Address additional security vulnerabilities in `js-yaml`. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/283.
17+
18+
### Migration Instructions
19+
20+
No changes required to start using v3.0.4 🎉.
21+
622
## [3.0.3] - 2019-04-18
723

824
### Bugs
925

1026
- **Socket.io disconnects / large stats object size**: Dramatically reduce the size of the webpack stats object being sent from client (webpack plugin) to server (CLI). Add client error/disconnect information for better future debugging. Original issue: https://github.com/FormidableLabs/inspectpack/issues/279 and fix: https://github.com/FormidableLabs/inspectpack/pull/281
1127

28+
### Migration Instructions
29+
30+
No changes required to start using v3.0.3 🎉.
31+
1232
## [3.0.2] - 2019-03-28
1333

1434
### Features

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
![](https://img.shields.io/npm/v/webpack-dashboard.svg?style=flat)
44
[![Maintenance Status][maintenance-image]](#maintenance-status)
55

6-
76
A CLI dashboard for your webpack dev server
87

98
### What's this all about?
@@ -128,6 +127,27 @@ cross-env EXAMPLE=tree-shaking node bin/webpack-dashboard.js -- webpack-cli --co
128127

129128
Then just run `yarn dev` to get up and running. PRs are very much appreciated!
130129

130+
### Publishing
131+
132+
When it comes time to publish a new version of `webpack-dashboard` to `npm`, authorized users can take the following steps:
133+
134+
```sh
135+
# Ensure build passes all CI checks.
136+
git pull origin master
137+
yarn check-ci
138+
139+
# Version the change. We use semantic versioning.
140+
yarn version --<major | minor | patch>
141+
142+
# Publish to npm.
143+
yarn publish
144+
145+
# Commit the release tag to source.
146+
git push && git push --tags
147+
```
148+
149+
Please also be sure to update `CHANGELOG.md` with release notes and draft the release on GitHub. We loosely follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) spec with categories for `Features`, `Bugs`, `Tests`, `Docs`, and `Security`. All releases should also include `Migration Instructions` for adopting the new release.
150+
131151
#### Credits
132152

133153
Module output deeply inspired by: [https://github.com/robertknight/webpack-bundle-size-analyzer](https://github.com/robertknight/webpack-bundle-size-analyzer)
@@ -136,8 +156,6 @@ Error output deeply inspired by: [https://github.com/facebookincubator/create-re
136156

137157
#### Maintenance Status
138158

139-
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
159+
**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
140160

141161
[maintenance-image]: https://img.shields.io/badge/maintenance-active-green.svg
142-
143-

0 commit comments

Comments
 (0)