Merge pull request #14 from bendemboski/release-it

Set up releases using release-it

Author: Ben Demboski

.gitignore

@@ -1,2 +1,3 @@
 /node_modules
 .DS_Store
+.env

RELEASE.md

@@ -0,0 +1,67 @@
+# 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 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 `release-it` installed globally, generally done by
+  using one of the following commands:
+
+```
+# using https://volta.sh
+volta install release-it
+
+# using Yarn
+yarn global add release-it
+
+# using npm
+npm install --global release-it
+```
+
+* Second, ensure that you have installed your projects dependencies:
+
+```
+yarn install
+```
+
+* And last (but not least 😁) do your release. It requires a
+  [GitHub personal access token](https://github.com/settings/tokens) as
+  `$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
+  or other scopes are required.
+
+```
+export GITHUB_AUTH="f941e0..."
+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,24 +2,54 @@
   "name": "electron-protocol-serve",
   "version": "1.3.0",
   "description": "A file protocol that serves any existing file in a directory and redirects everything not found to index.html.",
-  "main": "index.js",
   "repository": "git@github.com:pichfl/electron-protocol-ember.git",
-  "author": "Florian Pichler <pichfl@ylk.gd>",
   "license": "MIT",
+  "author": "Florian Pichler <pichfl@ylk.gd>",
+  "contributors": [
+    {
+      "name": "Florian Pichler",
+      "url": "http://ylk.gd/"
+    },
+    {
+      "name": "Ben Demboski",
+      "email": "ben@turbopatent.com",
+      "url": "https://github.com/bendemboski"
+    }
+  ],
+  "main": "index.js",
   "scripts": {
-    "test": "npm run mocha && npm run lint",
+    "lint": "eslint .",
     "mocha": "mocha ./tests/**/*-test.js",
-    "lint": "eslint ."
+    "test": "npm run mocha && npm run lint"
   },
   "devDependencies": {
     "bluebird": "^3.5.0",
     "chai": "^3.5.0",
+    "dotenv-cli": "^3.1.0",
     "eslint": "^3.17.1",
     "lodash": "^4.17.4",
     "mocha": "^3.2.0",
+    "mock-require": "^2.0.1",
+    "release-it": "^13.5.1",
+    "release-it-lerna-changelog": "^2.1.2",
     "sinon": "^1.17.7"
   },
-  "dependencies": {
-    "mock-require": "^2.0.1"
+  "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"
+    }
   }
 }