Update CHANGELOG and README.

FormidableLabs · Apr 24, 2019 · 768962c · 768962c
1 parent 399d7ec
commit 768962c
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,34 @@
-# Change Log
+# Changelog
 
 This project adheres to [Semantic Versioning](http://semver.org/).
 Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/FormidableLabs/webpack-dashboard/releases) page.
 
+## [3.0.4] - 2019-04-24
+
+### Features
+
+- Use `npm-run-all` as task runner for `package.json` scripts. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/283.
+- Use `test` in lieu of `test-summary` for `nyc` coverage reporting on command line. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/283.
+
+### Security
+
+- Address `handlebars` security vulnerability. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/282 by @juliusl.
+- Address additional security vulnerabilities in `js-yaml`. Included in: https://github.com/FormidableLabs/webpack-dashboard/pull/283.
+
+### Migration Instructions
+
+No changes required to start using v3.0.4 🎉.
+
 ## [3.0.3] - 2019-04-18
 
 ### Bugs
 
 - **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
 
+### Migration Instructions
+
+No changes required to start using v3.0.3 🎉.
+
 ## [3.0.2] - 2019-03-28
 
 ### Features

diff --git a/README.md b/README.md
@@ -3,7 +3,6 @@
 ![](https://img.shields.io/npm/v/webpack-dashboard.svg?style=flat)
 [![Maintenance Status][maintenance-image]](#maintenance-status)
 
-
 A CLI dashboard for your webpack dev server
 
 ### What's this all about?
@@ -128,6 +127,27 @@ cross-env EXAMPLE=tree-shaking node bin/webpack-dashboard.js -- webpack-cli --co
 
 Then just run `yarn dev` to get up and running. PRs are very much appreciated!
 
+### Publishing
+
+When it comes time to publish a new version of `webpack-dashboard` to `npm`, authorized users can take the following steps:
+
+```sh
+# Ensure build passes all CI checks.
+git pull origin master
+yarn check-ci
+
+# Version the change. We use semantic versioning.
+yarn version --<major | minor | patch>
+
+# Publish to npm.
+yarn publish
+
+# Commit the release tag to source.
+git push && git push --tags
+```
+
+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.
+
 #### Credits
 
 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
 
 #### Maintenance Status
 
-**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. 
+**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.
 
 [maintenance-image]: https://img.shields.io/badge/maintenance-active-green.svg
-
-