From 2d1ed24d64d8eac6dbd4834813cb255cc838a562 Mon Sep 17 00:00:00 2001 From: Andreas Lind Date: Sun, 22 Nov 2020 10:35:11 +0100 Subject: [PATCH] Add CHANGELOG.md + offline-github-changelog integration --- .prettierignore | 9 ++++++--- documentation/index.md | 4 ++++ package.json | 4 +++- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/.prettierignore b/.prettierignore index 66e3c4f..b390e72 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,8 +1,11 @@ -# Don't fight npm i --save -package.json - /node_modules /coverage /site-build /.nyc_output /testdata/ + +# Don't fight npm i --save +/package.json + +# Generated +/CHANGELOG.md diff --git a/documentation/index.md b/documentation/index.md index a38ec21..7930dab 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -16,6 +16,10 @@ repository: https://github.com/unexpectedjs/unexpected-mitm Plugin for Unexpected that allows you to mock out http(s) traffic via [mitm](https://github.com/moll/node-mitm) using a declarative syntax. +## Releases + +[Changelog](https://github.com/unexpectedjs/unexpected-mitm/blob/master/CHANGELOG.md) + ## License Unexpected-mitm is licensed under a standard 3-clause BSD license -- see the `LICENSE` file for details. diff --git a/package.json b/package.json index b81cde3..03910dd 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,8 @@ "coverage": "nyc --reporter=lcov --reporter=text --all npm test && echo google-chrome coverage/lcov-report/index.html", "generate-site": "generate-site --require ./bootstrap-unexpected-markdown.js", "update-examples": "generate-site --require ./bootstrap-unexpected-markdown.js --update-examples", - "deploy-site": "deploy-site.sh" + "deploy-site": "deploy-site.sh", + "preversion": "offline-github-changelog --next=${npm_package_version} > CHANGELOG.md && git add CHANGELOG.md" }, "peerDependencies": { "unexpected": "^10.27.0 || ^11.0.0-3 || ^12.0.0" @@ -37,6 +38,7 @@ "express": "^4.16.3", "mocha": "^8.2.1", "nyc": "^15.0.0", + "offline-github-changelog": "^1.7.0", "pem": "^1.13.1", "prettier": "~2.1.0", "request": "^2.53.0",