Merge pull request #289 from pretenderjs/release

Add release-it

Author: xg-wang

.release-it.json

@@ -0,0 +1,16 @@
+{
+  "plugins": {
+    "release-it-lerna-changelog": {
+      "infile": "CHANGELOG.md"
+    }
+  },
+  "git": {
+    "tagName": "v${version}"
+  },
+  "npm": {
+    "publish": true
+  },
+  "github": {
+    "release": true
+  }
+}

CHANGELOG.md

@@ -1,5 +1,3 @@
-# Pretender Changelog
-
 ## 3.2.0 (2019-12-22)
 
 #### :rocket: Enhancement

RELEASE.md

@@ -0,0 +1,41 @@
+# Release
+
+Releases are mostly automated using
+[release-it](https://github.com/release-it/release-it/) and
+[lerna-changelog](https://github.com/lerna/lerna-changelog/).
+
+
+## Preparation
+
+Since the majority of the actual release process is automated, the primary
+remaining task prior to releasing is confirming that all pull requests that
+have been merged since the last release have been labeled with the appropriate
+`lerna-changelog` labels and the titles have been updated to ensure they
+represent something that would make sense to our users. Some great information
+on why this is important can be found at
+[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
+guiding principles here is that changelogs are for humans, not machines.
+
+When reviewing merged PR's the labels to be used are:
+
+* breaking - Used when the PR is considered a breaking change.
+* enhancement - Used when the PR adds a new feature or enhancement.
+* bug - Used when the PR fixes a bug included in a previous release.
+* documentation - Used when the PR adds or updates documentation.
+* internal - Used for internal changes that still require a mention in the
+  changelog/release notes.
+
+
+## Release
+
+Once the prep work is completed, the actual release is straight forward:
+
+```
+yarn install
+yarn release
+```
+
+The `release` script leverages
+[release-it](https://github.com/release-it/release-it/) to do the mechanical
+release process. It will prompt you through the process of choosing the version
+number, tagging, pushing the tag and commits, etc.

package.json

@@ -7,6 +7,7 @@
   "description": "Pretender is a mock server library for XMLHttpRequest and Fetch, that comes with an express/sinatra style syntax for defining routes and their handlers.",
   "license": "MIT",
   "scripts": {
+    "release": "release-it",
     "prepublishOnly": "npm run build && npm run tests-only",
     "pretest": "bower install",
     "build": "rollup --config",
@@ -22,6 +23,9 @@
     "type": "git",
     "url": "https://github.com/pretenderjs/pretender.git"
   },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "devDependencies": {
     "abortcontroller-polyfill": "^1.1.9",
     "bower": "^1.8.2",
@@ -37,6 +41,8 @@
     "karma-sinon": "^1.0.5",
     "phantomjs": "^2.1.7",
     "qunit": "^2.6.1",
+    "release-it": "^12.4.3",
+    "release-it-lerna-changelog": "^1.0.3",
     "rollup": "^1.1.2",
     "rollup-plugin-commonjs": "^9.2.0",
     "rollup-plugin-multi-entry": "^2.1.0",