Use release-it for releasing

Author: lukemelia

RELEASE.md

@@ -1,20 +1,60 @@
-# Release
+# Release Process
 
-The following steps should navigate you through the release process to ensure as few issues as possible.
+Releases are mostly automated using
+[release-it](https://github.com/release-it/release-it/) and
+[lerna-changelog](https://github.com/lerna/lerna-changelog/).
 
-## Steps
+## Preparation
 
-### Commit the changelog, bump version, and publish to NPM
+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.
 
-1. run `./bin/changelog` and add output to `CHANGELOG.md`
-2. edit changelog output to be as user-friendly as possible (drop [INTERNAL] changes etc.)
-3. `ember release`
-4. `npm publish`
+When reviewing merged PR's the labels to be used are:
 
-### Create a github release
+* 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.
 
-1. under `Releases` on GitHub choose `Draft New Release`
-2. enter the new version number created above as the tag, prefixed with v e.g. (v0.1.12)
-3. for release title choose a great name, no pressure.
-4. in the description paste the upgrade instructions from the previous release, followed by the new CHANGELOG entry
-5. publish the release
+## 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.

bin/changelog

@@ -2,42 +2,60 @@
   "name": "ember-cli-deploy-revision-data",
   "version": "1.0.0",
   "description": "An ember-cli-deploy plugin to generate data about this deploy revision including a unique revision key based on the current build",
+  "keywords": [
+    "ember-addon",
+    "ember-cli-deploy-plugin"
+  ],
+  "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data",
+  "license": "MIT",
+  "author": "Aaron Chambers and the ember-cli-deploy team",
   "directories": {
     "doc": "doc",
     "test": "tests"
   },
   "scripts": {
     "test": "eslint index.js lib/**/*.js tests/**/*.js && node ./tests/runner.js"
   },
-  "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy-revision-data",
-  "engines": {
-    "node": ">= 4"
+  "dependencies": {
+    "chalk": "^4.1.1",
+    "core-object": "^3.1.5",
+    "ember-cli-deploy-plugin": "^0.2.9",
+    "git-repo-info": "^2.1.1",
+    "minimatch": "^3.0.4",
+    "rsvp": "^4.8.5",
+    "simple-git": "^2.38.0"
   },
-  "author": "Aaron Chambers and the ember-cli-deploy team",
-  "license": "MIT",
   "devDependencies": {
     "@octokit/rest": "^18.5.3",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "ember-cli": "^3.26.1",
-    "ember-cli-release": "1.0.0-beta.2",
     "eslint": "^7.25.0",
     "glob": "^7.1.6",
     "mocha": "^8.3.2",
-    "multiline": "^1.0.2"
+    "release-it": "^14.6.1",
+    "release-it-lerna-changelog": "^3.1.0"
   },
-  "keywords": [
-    "ember-addon",
-    "ember-cli-deploy-plugin"
-  ],
-  "dependencies": {
-    "chalk": "^4.1.1",
-    "core-object": "^3.1.5",
-    "ember-cli-deploy-plugin": "^0.2.9",
-    "git-repo-info": "^2.1.1",
-    "minimatch": "^3.0.4",
-    "rsvp": "^4.8.5",
-    "simple-git": "^2.38.0"
+  "engines": {
+    "node": ">= 12"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "release-it": {
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": false
+      }
+    },
+    "git": {
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    }
   },
   "volta": {
     "node": "14.16.1",