Merge pull request #90 from rwjblue/update-release-setup

Update automated release steps

Author: rwjblue

RELEASE.md

@@ -14,7 +14,7 @@ have been merged since the last release have been labeled with the appropriate
 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.
+guiding principle here is that changelogs are for humans, not machines.
 
 When reviewing merged PR's the labels to be used are:
 
@@ -30,12 +30,33 @@ When reviewing merged PR's the labels to be used are:
 
 Once the prep work is completed, the actual release is straight forward:
 
+* First, ensure that you have installed your projects dependencies:
+
 ```
 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.
+* 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.
+
+```
+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

@@ -16,18 +16,18 @@
   },
   "license": "MIT",
   "author": "Robert Jackson <[email protected]>",
-  "files": [
-    "src",
-    "bin",
-    "commands"
-  ],
   "main": "src/index.js",
   "bin": {
     "codemod-cli": "./bin/cli.js"
   },
   "directories": {
     "test": "tests"
   },
+  "files": [
+    "src",
+    "bin",
+    "commands"
+  ],
   "scripts": {
     "lint": "eslint .",
     "lint:js": "eslint .",
@@ -60,8 +60,8 @@
     "jest": "^24.9.0",
     "prettier": "^1.18.2",
     "qunit": "^2.9.2",
-    "release-it": "^12.4.1",
-    "release-it-lerna-changelog": "^1.0.3",
+    "release-it": "^13.6.5",
+    "release-it-lerna-changelog": "^2.3.0",
     "require-so-slow": "^1.2.0",
     "walk-sync": "^2.0.2"
   },
@@ -74,14 +74,16 @@
   "release-it": {
     "plugins": {
       "release-it-lerna-changelog": {
-        "infile": "CHANGELOG.md"
+        "infile": "CHANGELOG.md",
+        "launchEditor": true
       }
     },
     "git": {
       "tagName": "v${version}"
     },
     "github": {
-      "release": true
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
     }
   }
 }