Add rwjblue release-it config

Author: RobbieTheWagner

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

@@ -15,27 +15,46 @@
     "email": "[email protected]",
     "url": "https://github.com/rwwagner90"
   },
+  "main": "dist/vue-shepherd.common.js",
+  "jsdelivr": "dist/vue-shepherd.umd.min.js",
+  "unpkg": "dist/vue-shepherd.umd.min.js",
+  "module": "dist/vue-shepherd.esm.js",
+  "files": [
+    "dist/vue-shepherd.common.js",
+    "dist/vue-shepherd.umd.min.js",
+    "dist/vue-shepherd.umd.js",
+    "dist/vue-shepherd.esm.js",
+    "src"
+  ],
   "scripts": {
-    "serve": "yarn demo",
     "build": "vue-cli-service build",
-    "lint": "vue-cli-service lint",
     "demo": "vue-cli-service demo",
     "docs": "yarn docs:serve",
     "docs:build": "vue-cli-service docs --mode build",
     "docs:serve": "vue-cli-service docs --mode serve",
+    "lint": "vue-cli-service lint",
     "prepublish": "yarn lint && yarn build",
+    "serve": "yarn demo",
     "start": "yarn serve"
   },
-  "main": "dist/vue-shepherd.common.js",
-  "module": "dist/vue-shepherd.esm.js",
-  "unpkg": "dist/vue-shepherd.umd.min.js",
-  "files": [
-    "dist/vue-shepherd.common.js",
-    "dist/vue-shepherd.umd.min.js",
-    "dist/vue-shepherd.umd.js",
-    "dist/vue-shepherd.esm.js",
-    "src"
+  "browserslist": [
+    "> 1%",
+    "last 2 versions"
   ],
+  "eslintConfig": {
+    "env": {
+      "node": true
+    },
+    "parserOptions": {
+      "parser": "babel-eslint"
+    },
+    "extends": [
+      "plugin:vue/essential",
+      "eslint:recommended"
+    ],
+    "rules": {},
+    "root": true
+  },
   "dependencies": {
     "shepherd.js": "^8.0.1"
   },
@@ -46,32 +65,33 @@
     "babel-eslint": "^10.1.0",
     "eslint": "^7.3.0",
     "eslint-plugin-vue": "^6.2.2",
+    "release-it": "^13.6.0",
+    "release-it-lerna-changelog": "^2.3.0",
     "vue-cli-plugin-p11n": "^0.4.0",
     "vue-template-compiler": "^2.6.11"
   },
-  "eslintConfig": {
-    "root": true,
-    "env": {
-      "node": true
-    },
-    "extends": [
-      "plugin:vue/essential",
-      "eslint:recommended"
-    ],
-    "rules": {},
-    "parserOptions": {
-      "parser": "babel-eslint"
-    }
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
   },
   "postcss": {
     "plugins": {
       "autoprefixer": {}
     }
   },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions"
-  ],
-  "jsdelivr": "dist/vue-shepherd.umd.min.js",
+  "release-it": {
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": false
+      }
+    },
+    "git": {
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    }
+  },
   "sideeffects": false
 }