From 2cba82f75f021cf359df3d938bb61464842eaea1 Mon Sep 17 00:00:00 2001 From: Andreas Lind Date: Sun, 22 Nov 2020 14:09:33 +0100 Subject: [PATCH] Add CHANGELOG.md + offline-github-changelog integration --- .prettierignore | 7 ++- CHANGELOG.md | 162 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++ package.json | 4 +- 4 files changed, 175 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.prettierignore b/.prettierignore index 9f64fe2..130ef52 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,9 @@ +/node_modules/ +/.nyc_output/ /coverage/ # Don't fight npm i --save -package.json +/package.json + +# Generated +/CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8d02766 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,162 @@ +### v2.2.0 (2020-07-22) + +#### Pull requests + +- [#44](https://github.com/papandreou/node-optipng/pull/44) Upgrade optipng-bin to version 7.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#43](https://github.com/papandreou/node-optipng/pull/43) Upgrade eslint-plugin-mocha to version 7.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#42](https://github.com/papandreou/node-optipng/pull/42) Upgrade eslint to version 7.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#39](https://github.com/papandreou/node-optipng/pull/39) Upgrade sinon to version 9.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#38](https://github.com/papandreou/node-optipng/pull/38) Upgrade mocha to version 7.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#37](https://github.com/papandreou/node-optipng/pull/37) Upgrade eslint-plugin-node to version 11.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#35](https://github.com/papandreou/node-optipng/pull/35) Upgrade nyc to version 15.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#36](https://github.com/papandreou/node-optipng/pull/36) Upgrade sinon to version 8.0.1 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#34](https://github.com/papandreou/node-optipng/pull/34) Upgrade which to version 2.0.1 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#33](https://github.com/papandreou/node-optipng/pull/33) Upgrade eslint-plugin-node to version 10.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#32](https://github.com/papandreou/node-optipng/pull/32) Upgrade eslint-config-standard to version 14.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#31](https://github.com/papandreou/node-optipng/pull/31) Upgrade eslint-plugin-mocha to version 6.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#30](https://github.com/papandreou/node-optipng/pull/30) Upgrade eslint-config-standard to version 13.0.1 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#29](https://github.com/papandreou/node-optipng/pull/29) Upgrade eslint-config-prettier to version 6.0.0 ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [#27](https://github.com/papandreou/node-optipng/pull/27) Upgrade eslint-config-prettier to version 5.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) + +#### Commits to master + +- [Pass windowsHide:true to childProcess.spawn](https://github.com/papandreou/node-optipng/commit/b01837a9776605a0e5f7db236169f1c75fb30ee3) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [prettier --write '\*\*\/\*.{md,js}'](https://github.com/papandreou/node-optipng/commit/25542e0b31434d621de3e35914b9a703a76d64b3) ([Andreas Lind](mailto:andreas.lind@peakon.com)) +- [Update CI setup, also run on latest node, only lint on node 12](https://github.com/papandreou/node-optipng/commit/520ee148593a57a19324330243aff34714bcc609) ([Andreas Lind](mailto:andreas.lind@peakon.com)) +- [Also enable prettier for markdown files](https://github.com/papandreou/node-optipng/commit/2bc2025172b44e73a6ae8aca01c641f37503acf0) ([Andreas Lind](mailto:andreas.lind@peakon.com)) +- [Update prettier to version 2.0.2](https://github.com/papandreou/node-optipng/commit/19cf37c58c0685180a813e57193ab0a5bf368217) ([depfu[bot]](mailto:23717796+depfu[bot]@users.noreply.github.com)) +- [+4 more](https://github.com/papandreou/node-optipng/compare/v2.1.0...v2.2.0) + +### v2.1.0 (2019-05-27) + +#### Pull requests + +- [#26](https://github.com/papandreou/node-optipng/pull/26) Upgrade optipng-bin to version 6.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#25](https://github.com/papandreou/node-optipng/pull/25) Upgrade unexpected-stream to version 4.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#23](https://github.com/papandreou/node-optipng/pull/23) Upgrade nyc to version 14.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#22](https://github.com/papandreou/node-optipng/pull/22) Upgrade mocha to version 6.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#21](https://github.com/papandreou/node-optipng/pull/21) Upgrade unexpected to version 11.0.0 ([Andreas Lind](mailto:andreas.lind@peakon.com), [depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) + +#### Commits to master + +- [Drop node.js 6 support, add 12 \(semver-major\)](https://github.com/papandreou/node-optipng/commit/6958c3f8bb9b2107c7c250737fd79b520939ddbe) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [Update eslint-plugin-node to version 9.0.1](https://github.com/papandreou/node-optipng/commit/0c6a7d5479db7fc8a48cb085d2e1264d562d15eb) ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [Add \/coverage\/ to .prettierignore](https://github.com/papandreou/node-optipng/commit/bb5126b1edfce7df7536027da5772ce9fae81f2d) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [prettier --write '\*\*\/\*.js'](https://github.com/papandreou/node-optipng/commit/944bfae0e5e544bd0eb99595740352ca8caca69a) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [Fix lint](https://github.com/papandreou/node-optipng/commit/0679cba2e9c7255ebe30fd9b27f15470e8b2fc49) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [+4 more](https://github.com/papandreou/node-optipng/compare/v2.0.0...v2.1.0) + +### v2.0.0 (2018-11-16) + +#### Pull requests + +- [#19](https://github.com/papandreou/node-optipng/pull/19) Upgrade optipng-bin to version 5.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#18](https://github.com/papandreou/node-optipng/pull/18) Upgrade sinon to version 7.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#17](https://github.com/papandreou/node-optipng/pull/17) Upgrade unexpected-stream to version 3.0.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#15](https://github.com/papandreou/node-optipng/pull/15) Upgrade mocha to version 5.2.0 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) +- [#16](https://github.com/papandreou/node-optipng/pull/16) Upgrade sinon to version 6.3.5 ([depfu[bot]](mailto:depfu[bot]@users.noreply.github.com)) + +#### Commits to master + +- [Use const instead of var](https://github.com/papandreou/node-optipng/commit/94b0ba1edde8a5a5ed87f62ae8290350028003dd) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [Fix up test, move it nearer to the other error handling ones](https://github.com/papandreou/node-optipng/commit/99d3d78d0e24ea714de95fbef916cf520e90adbe) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [Avoid calling end of undefined right after](https://github.com/papandreou/node-optipng/commit/4d9d5a77f31a6f8c0726c9595718c3fcba6ec123) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [Fix lint](https://github.com/papandreou/node-optipng/commit/39f8e30e497f08b5e99259c6bc991c5a87f2f5cc) ([Andreas Lind](mailto:andreaslindpetersen@gmail.com)) +- [Throw an error when closing a stream that hasn't been started yet.](https://github.com/papandreou/node-optipng/commit/dfee4535b35a4fc94ad1f7e9dd215c2a11039b2e) ([Robert Stiff](mailto:uatecuk@gmail.com)) +- [+23 more](https://github.com/papandreou/node-optipng/compare/v1.1.0...v2.0.0) + +### v1.1.0 (2017-04-27) + +- [Travis: Build with node.js 4, 6, and 7.](https://github.com/papandreou/node-optipng/commit/674278f7bf58a920cd6f0c74251f1bb5c9d7dca2) ([Andreas Lind](mailto:andreas@one.com)) +- [Update optipng-bin to 3.1.4.](https://github.com/papandreou/node-optipng/commit/7c62ad10b4595c8d5b6d7815025ba00049825617) ([Andreas Lind](mailto:andreas@one.com)) +- [Update gettemporaryfilepath, memoizeasync, and which](https://github.com/papandreou/node-optipng/commit/94bb492853d706ec91eeb38b623fa085032418d3) ([Andreas Lind](mailto:andreas@one.com)) +- [Use ^ version ranges for dev deps.](https://github.com/papandreou/node-optipng/commit/bde40af57bcf97e93b506590ed6dc76729e8c47f) ([Andreas Lind](mailto:andreas@one.com)) +- [Update dev deps.](https://github.com/papandreou/node-optipng/commit/0360c5aa2542b791bebbf5e84daa41ca90608b7a) ([Andreas Lind](mailto:andreas@one.com)) +- [+3 more](https://github.com/papandreou/node-optipng/compare/v1.0.0...v1.1.0) + +### v1.0.0 (2016-03-31) + +- [Implement destroy method, improve cleaning up code when erroring out.](https://github.com/papandreou/node-optipng/commit/7abaf35c55f241428f4a85bbbee93bae0eb24598) ([Andreas Lind](mailto:andreas@one.com)) +- [.jshintrc: Don't enforce es3 mode.](https://github.com/papandreou/node-optipng/commit/6976abf21adb09b9b26f75701aab810d88ad7270) ([Andreas Lind](mailto:andreas@one.com)) + +### v0.3.1 (2015-07-29) + +- [Whoops, rename back OptiPng.getBin{ => ary}Path.](https://github.com/papandreou/node-optipng/commit/a155f2b078224be18367847bbcbd3df3c379deea) ([Andreas Lind](mailto:andreas@one.com)) + +### v0.3.0 (2015-07-29) + +- [package.json: Removed equal signs from dependencies.](https://github.com/papandreou/node-optipng/commit/fa6711f3ef2b29430afcd15edea706e4078ce352) ([Andreas Lind](mailto:andreas@one.com)) +- [package.json: Fixed author name :\)](https://github.com/papandreou/node-optipng/commit/40253c99c79728c5c5aa23dbcdcec867ab1d7f69) ([Andreas Lind](mailto:andreas@one.com)) +- [Update optipng-bin to 3.0.2.](https://github.com/papandreou/node-optipng/commit/fc6add049c5d1edf000e211c45418db4e914658e) ([Andreas Lind](mailto:andreas@one.com)) +- [package.json: Use a valid SPDX identifier for the license field.](https://github.com/papandreou/node-optipng/commit/e2ac5f9de702c2c0312ea421b303a15e681df0ed) ([Andreas Lind](mailto:andreas@one.com)) +- [Use unexpected-stream.](https://github.com/papandreou/node-optipng/commit/a782e43f483df5e7869b0f4d2baeb94e0581d5ed) ([Andreas Lind](mailto:andreas@one.com)) +- [+1 more](https://github.com/papandreou/node-optipng/compare/v0.2.1...v0.3.0) + +### v0.2.1 (2015-06-26) + +#### Pull requests + +- [#7](https://github.com/papandreou/node-optipng/pull/7) emit the error before closing the stream ([Sky Higgins](mailto:eveningsky@gmail.com)) + +#### Commits to master + +- [Fixed the last README badge.](https://github.com/papandreou/node-optipng/commit/d08518d67b02aedbb2740f72b48759befcf9c7a2) ([Andreas Lind](mailto:andreas@one.com)) + +### v0.2.0 (2015-06-26) + +#### Pull requests + +- [#6](https://github.com/papandreou/node-optipng/pull/6) streams2 working with node 0.10 & 0.12 ([Sky Higgins](mailto:eveningsky@gmail.com)) + +#### Commits to master + +- [Style\/whitespace fixes.](https://github.com/papandreou/node-optipng/commit/5654c11cd4e1808e41459d39cd5e5e9e41e13f51) ([Andreas Lind](mailto:andreas@one.com)) +- [Undo some variable and instance variable renames.](https://github.com/papandreou/node-optipng/commit/d325761d23ede716b43dd91027b43681169af0a5) ([Andreas Lind](mailto:andreas@one.com)) +- [Fixed badge urls.](https://github.com/papandreou/node-optipng/commit/a9746e32b342d221bfbc45b1d69f8e83e50caeba) ([Andreas Lind](mailto:andreas@one.com)) +- [Travis: Install optipng in the before\_install hook.](https://github.com/papandreou/node-optipng/commit/fd952986a9121807e320af47bd4dc4216e60b1cc) ([Andreas Lind](mailto:andreas@one.com)) +- [Add jshint, istanbul, Travis & coveralls integration.](https://github.com/papandreou/node-optipng/commit/3b4fc5c6e0331958029820cbf537021185f8f097) ([Andreas Lind](mailto:andreas@one.com)) +- [+1 more](https://github.com/papandreou/node-optipng/compare/v0.1.1...v0.2.0) + +### v0.1.1 (2014-09-22) + +- [Damn, fixed stupid error in 0.1.0.](https://github.com/papandreou/node-optipng/commit/32a5328e1fafc56f33e3b0561d8f7a16c716b248) ([Andreas Lind](mailto:andreas@one.com)) + +### v0.1.0 (2014-09-22) + +- [Don't fs.createWriteStream until the first .write call.](https://github.com/papandreou/node-optipng/commit/4acb6ad863f0fbd1b351169730fedcc1c1f6119f) ([Andreas Lind](mailto:andreas@one.com)) +- [Minor code style.](https://github.com/papandreou/node-optipng/commit/91b6acc0ba2dc921b9fd50f9ae58836b3eb156c3) ([Andreas Lind Petersen](mailto:andreas@one.com)) + +### v0.0.6 +- [Avoid calling the callback more than once.](https://github.com/papandreou/node-optipng/commit/7524db207fc951c309f806440499d825e4c6e049) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Expose the command line as a public property.](https://github.com/papandreou/node-optipng/commit/3689f3ac2de9f6c018799fe882af087093a69d5e) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Update mocha to 1.19.0.](https://github.com/papandreou/node-optipng/commit/1cbe5501aed85cef29aabb384ebcd04778e393cd) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Update unexpected to 3.2.0.](https://github.com/papandreou/node-optipng/commit/c537c528b43fd117a5e037e165c3887df3851aea) ([Andreas Lind Petersen](mailto:andreas@one.com)) + +### v0.0.5 (2014-03-25) + +- [Forward errors emitted by the child process to the OptiPng instance.](https://github.com/papandreou/node-optipng/commit/62dc97c8ed4b32d69bec04d3151544351833f13b) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Tests: Replace expect.js with unexpected.](https://github.com/papandreou/node-optipng/commit/566f8fffdc22d6b6ef809522e2508a11d5f085ee) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [package.json: Indent with 2 spaces.](https://github.com/papandreou/node-optipng/commit/9d623f8395b2849e3951ff7e491d4ac89702580c) ([Andreas Lind Petersen](mailto:andreas@one.com)) + +### v0.0.4 +- [Release 0.0.4.](https://github.com/papandreou/node-optipng/commit/d91b0418d1cc10ab2a7f6133b7e807b255b6f2fb) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Expose getBinaryPath on the constructor.](https://github.com/papandreou/node-optipng/commit/96959d9e7ce2b91b522e36d0c7ea48b8b0d1c59b) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [More consistent variable names.](https://github.com/papandreou/node-optipng/commit/e301d8fb4454b4d82875bd8c778f86b07c7d4f60) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [README: Mention that node-optipng-bin is used.](https://github.com/papandreou/node-optipng/commit/bc096a08da36839d54e1beabeccebea7e57a480b) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Prefer an optipng binary in PATH over the ones provided by optipng-bin.](https://github.com/papandreou/node-optipng/commit/eff807a2647ca1e4708bc65f5ef413a6f8866345) ([Andreas Lind Petersen](mailto:andreas@one.com)) + +### v0.0.3 +- [Release 0.0.3.](https://github.com/papandreou/node-optipng/commit/b1a7120e075337dfa2e958c92a7621edfe6fd9fa) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Get prebuilt binaries from optipng-bin. Fixes \#1.](https://github.com/papandreou/node-optipng/commit/1c8b887c55bcc3bc307bd53a276d71eedcbb051a) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Test that an error is emitted when an invalid image is processed.](https://github.com/papandreou/node-optipng/commit/a4b8d0bc4e932e843c6248e7808a3fcaa9e666de) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [package.json: One more keyword.](https://github.com/papandreou/node-optipng/commit/9f1a6586f507ce6c2bc393a926e8adc50144ebf6) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [README: myCrusher => myOptimizer](https://github.com/papandreou/node-optipng/commit/6a90e8351f017fe1e3534734bd06c0d718fe10dd) ([Andreas Lind Petersen](mailto:andreas@one.com)) + +### v0.0.2 +- [Release 0.0.2.](https://github.com/papandreou/node-optipng/commit/62f79f748a9fec9b0208b5bf145d2189c0b61fcd) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [Stream the incoming chunks to disc using a fs.WriteStream instead of buffering.](https://github.com/papandreou/node-optipng/commit/dbd3fd0aee8a37ba8c6b001410ee96d8649142fe) ([Andreas Lind Petersen](mailto:andreas@one.com)) +- [README: Made it clear that the optipng binary is required.](https://github.com/papandreou/node-optipng/commit/10ec3f4c2838d4d0e10f1de8af80e2ab9945247f) ([Andreas Lind Petersen](mailto:andreas@one.com)) + +### v0.0.1 +- [Initial commit, release 0.0.1.](https://github.com/papandreou/node-optipng/commit/23b515aee9a98d5d473e25d79a5771fff6196b9e) ([Andreas Lind Petersen](mailto:andreas@one.com)) + diff --git a/README.md b/README.md index 4ea54c1..3cac687 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,10 @@ Make sure you have node.js and npm installed, then run: npm install optipng +## Releases + +[Changelog](https://github.com/papandreou/unexpectednode-optipng/blob/master/CHANGELOG.md) + ## License 3-clause BSD license -- see the `LICENSE` file for details. diff --git a/package.json b/package.json index c8df27d..330b522 100644 --- a/package.json +++ b/package.json @@ -24,6 +24,7 @@ "eslint-plugin-standard": "^4.0.0", "mocha": "^7.0.0", "nyc": "^15.0.0", + "offline-github-changelog": "^2.0.0", "prettier": "~2.2.0", "sinon": "^9.0.0", "unexpected": "^12.0.0", @@ -34,7 +35,8 @@ "lint": "eslint . && prettier --check '**/*.{js,json,md}'", "test": "mocha", "test:ci": "npm run coverage", - "coverage": "nyc --reporter=lcov --reporter=text --all -- npm test && echo google-chrome coverage/lcov-report/index.html" + "coverage": "nyc --reporter=lcov --reporter=text --all -- npm test && echo google-chrome coverage/lcov-report/index.html", + "preversion": "offline-github-changelog --next=${npm_package_version} > CHANGELOG.md && git add CHANGELOG.md" }, "repository": { "type": "git",