Merge pull request #179 from ember-template-lint/release-it

Setup release-it with `yarn create rwjblue-release-it-setup`

Author: dcyriller

RELEASE.md

@@ -1,11 +1,60 @@
-# RELEASE
-
-Here are the steps:
-1. run these commands
-```bash
-- yarn version
-- git push origin master the-new-tag
-- yarn changelog --from=previous-tag >> CHANGELOG.md (manual cleanup)
-- npm publish
+# Release Process
+
+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 installed your projects dependencies:
+
+```sh
+yarn install
 ```
-2. Draft a release: https://github.com/dcyriller/ember-template-lint-plugin-prettier/releases/new
+
+* 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.

package.json

@@ -1,6 +1,7 @@
 {
   "name": "ember-template-lint-plugin-prettier",
   "version": "3.0.0",
+  "private": false,
   "description": "A prettier plugin for ember-template-lint",
   "keywords": [
     "ember-template-lint",
@@ -9,27 +10,25 @@
     "glimmer",
     "prettier"
   ],
+  "repository": "[email protected]:ember-template-lint/ember-template-lint-plugin-prettier.git",
+  "license": "Apache-2.0",
+  "author": "Cyrille David <'[email protected]'>",
+  "main": "ember-template-lint-plugin-prettier.js",
   "files": [
     "ember-template-lint-plugin-prettier.js",
     "lib",
     "docs"
   ],
-  "main": "ember-template-lint-plugin-prettier.js",
   "scripts": {
-    "changelog": "lerna-changelog",
+    "format": "yarn prettier '**/*.{hbs,js,json,yml}' --write",
     "lint": "npm-run-all lint:* --continue-on-error",
     "lint:docs": "markdownlint 'docs/**/*.md'",
     "lint:js": "eslint . --cache",
-    "test": "mocha --recursive",
-    "format": "yarn prettier '**/*.{hbs,js,json,yml}' --write"
+    "release": "release-it",
+    "test": "mocha --recursive"
   },
-  "repository": "[email protected]:dcyriller/ember-template-lint-plugin-prettier.git",
-  "author": "Cyrille David <'[email protected]'>",
-  "license": "Apache-2.0",
-  "private": false,
-  "peerDependencies": {
-    "ember-template-lint": ">=2.10.0",
-    "prettier": ">=1.18.1"
+  "dependencies": {
+    "prettier-linter-helpers": "^1.0.0"
   },
   "devDependencies": {
     "ember-template-lint": "^3.4.2",
@@ -41,13 +40,34 @@
     "markdownlint-cli": "^0.29.0",
     "mocha": "^9.0.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.3.1"
+    "prettier": "^2.3.1",
+    "release-it": "^14.11.6",
+    "release-it-lerna-changelog": "^4.0.1"
+  },
+  "peerDependencies": {
+    "ember-template-lint": ">=2.10.0",
+    "prettier": ">=1.18.1"
   },
   "engines": {
     "node": "12.* || 14.* || >= 16.*"
   },
-  "dependencies": {
-    "prettier-linter-helpers": "^1.0.0"
+  "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": "12.22.7",