add release-it config

Author: Suchita Doshi

RELEASE.md

@@ -0,0 +1,65 @@
+# 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:
+
+* 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:
+
+```
+# using yarn
+yarn install
+
+# using npm
+npm install
+```
+
+* And last (but not least 😁) do your release:
+
+```
+release-it
+```
+
+[release-it](https://github.com/release-it/release-it/) manages the actual
+release process. It will prompt you through the process of choosing the version
+number, tagging, pushing the tag and commits, etc.

package.json

@@ -1,25 +1,32 @@
 {
   "name": "ember-tracked-properties-codemod",
-  "description": "A codemod for transforming your ember app code to start using `@tracked` properties.",
   "version": "0.2.0",
+  "description": "A codemod for transforming your ember app code to start using `@tracked` properties.",
+  "keywords": [
+    "codemod-cli",
+    "codemods",
+    "ember",
+    "ember-codemod",
+    "ember-tracked-properties"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/suchitadoshi1987/ember-tracked-properties-codemod"
+  },
+  "license": "MIT",
   "author": {
     "name": "Suchita Doshi",
     "email": "[email protected]",
     "url": "https://github.com/suchitadoshi1987"
   },
-  "license": "MIT",
+  "bin": "./bin/cli.js",
   "scripts": {
     "test": "codemod-cli test",
     "update-docs": "codemod-cli update-docs"
   },
-  "bin": "./bin/cli.js",
-  "keywords": [
-    "codemod-cli",
-    "codemods",
-    "ember",
-    "ember-codemod",
-    "ember-tracked-properties"
-  ],
+  "jest": {
+    "testEnvironment": "node"
+  },
   "dependencies": {
     "codemod-cli": "^2.1.0"
   },
@@ -29,20 +36,31 @@
     "eslint": "^5.9.0",
     "eslint-config-prettier": "^3.3.0",
     "eslint-plugin-prettier": "^3.0.0",
+    "jest": "^23.1.0",
     "prettier": "^1.15.2",
-    "jest": "^23.1.0"
-  },
-  "jest": {
-    "testEnvironment": "node"
+    "release-it": "^12.2.1",
+    "release-it-lerna-changelog": "^1.0.3"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/suchitadoshi1987/ember-tracked-properties-codemod"
+  "engines": {
+    "node": "8.* || 10.* || >= 12.*"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
-  "engines": {
-    "node": "8.* || 10.* || >= 12.*"
+  "release-it": {
+    "hooks": {
+      "after:bump": "yarn update-docs"
+    },
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md"
+      }
+    },
+    "git": {
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true
+    }
   }
 }