Merge pull request #391 from BackburnerJS/add-release-automation

Add basic release automation setup.

Author: rwjblue

CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

RELEASE.md

@@ -0,0 +1,60 @@
+# Release Process
+
+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 principle 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:
+
+* First, ensure that you have installed your projects dependencies:
+
+```sh
+yarn install
+```
+
+* Second, ensure that you have obtained a
+  [GitHub personal access token][generate-token] with the `repo` scope (no
+  other permissions are needed). Make sure the token is available as the
+  `GITHUB_AUTH` environment variable.
+
+  For instance:
+
+  ```bash
+  export GITHUB_AUTH=abc123def456
+  ```
+
+[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
+
+* And last (but not least 😁) do your release.
+
+```sh
+npx release-it
+```
+
+[release-it](https://github.com/release-it/release-it/) manages the actual
+release process. It will prompt you to to choose the version number after which
+you will have the chance to hand tweak the changelog to be used (for the
+`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
+pushing the tag and commits, etc.

package.json

@@ -2,15 +2,15 @@
   "name": "backburner.js",
   "version": "2.6.0",
   "description": "Backburner.js is a simple run loop-esque library for coalescing actions",
-  "license": "MIT",
-  "author": "Erik Bryn",
-  "main": "dist/backburner.js",
-  "types": "dist/backburner.d.ts",
-  "jsnext:main": "dist/backburner.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/BackburnerJS/backburner.js.git"
   },
+  "license": "MIT",
+  "author": "Erik Bryn",
+  "main": "dist/backburner.js",
+  "jsnext:main": "dist/backburner.js",
+  "types": "dist/backburner.d.ts",
   "scripts": {
     "bench": "ember build && node ./bench/index.js",
     "build": "ember build --environment=production",
@@ -35,9 +35,29 @@
     "loader.js": "^4.7.0",
     "lolex": "^6.0.0",
     "qunit": "^2.14.1",
+    "release-it": "^14.2.1",
+    "release-it-lerna-changelog": "^3.1.0",
     "rollup-plugin-buble": "^0.19.8",
     "rollup-plugin-commonjs": "^10.1.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "tslint": "^6.1.3"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "release-it": {
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": true
+      }
+    },
+    "git": {
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    }
   }
 }