Add release-it

Author: gitKrystan

CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

CONTRIBUTING.md

@@ -25,15 +25,7 @@ See test-setup.ts for information about useful test setup hooks.
 
 ## Publishing
 
-```shell
-git commit
-git push
-yarn login
-yarn publish
-# now check to make sure the published package works
-git push
-git push --tags
-```
+See the [Release](RELEASE.md) guide for details.
 
 ## Running docs server in dev
 
@@ -60,6 +52,8 @@ Visit http://localhost:4200/
 
 ## Deploying docs
 
+NOTE: This is done automatically during releases.
+
 ```shell
 yarn docs:deploy
 ```

RELEASE.md

@@ -0,0 +1,44 @@
+# 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 (see below) and
+- [ ] have titles that 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 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
+
+- Then do your release.
+
+```sh
+yarn release
+```
+
+[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, deploying the docs, etc.

package.json

@@ -2,27 +2,27 @@
   "name": "event-perk-grid",
   "version": "0.1.7",
   "description": "A utility for reading and displaying Event Perk Grids.",
-  "main": "dist/index.js",
+  "keywords": [],
+  "homepage": "https://tildeio.github.io/event-perk-grid",
+  "bugs": {
+    "url": "https://github.com/tildeio/event-perk-grid/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tildeio/event-perk-grid.git"
+  },
+  "license": "MIT",
+  "author": "Tilde Engineering <[email protected]> (https://tilde.io)",
   "exports": {
     ".": "./dist/index.js",
     "./custom-element": "./dist/custom-element.js",
     "./index.css": "./dist/index.css"
   },
+  "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist/**/*"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tildeio/event-perk-grid.git"
-  },
-  "keywords": [],
-  "author": "Tilde Engineering <[email protected]> (https://tilde.io)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/tildeio/event-perk-grid/issues"
-  },
-  "homepage": "https://tildeio.github.io/event-perk-grid",
   "scripts": {
     "build:test": "webpack --mode development -c webpack.tests.config.js",
     "build:testem": "TESTEM=true webpack --mode development -c webpack.tests.config.js",
@@ -35,10 +35,9 @@
     "lint:fix": "npm-run-all --continue-on-error lint:*:fix",
     "start": "webpack serve --open --mode development -c webpack.tests.config.js",
     "test": "testem",
-    "preversion": "yarn lint && yarn build && yarn test && yarn docs",
-    "prepare": "yarn build",
     "docs": "typedoc",
-    "docs:deploy": "yarn docs && cd docs && yarn ember deploy production"
+    "docs:deploy": "yarn docs && cd docs && yarn ember deploy production",
+    "release": "release-it"
   },
   "devDependencies": {
     "@types/dotenv-webpack": "^7.0.3",
@@ -65,6 +64,8 @@
     "prettier": "^2.5.1",
     "qunit": "^2.17.2",
     "qunit-dom": "^2.0.0",
+    "release-it": "^14.2.1",
+    "release-it-lerna-changelog": "^3.1.0",
     "style-loader": "^3.3.1",
     "stylelint": "^14.4.0",
     "stylelint-config-prettier": "^9.0.3",
@@ -77,11 +78,42 @@
     "webpack-cli": "^4.9.2",
     "webpack-dev-server": "^4.7.4"
   },
-  "volta": {
-    "node": "14.18.3",
-    "yarn": "1.22.17"
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
   },
   "msw": {
     "workerDirectory": "tests"
+  },
+  "release-it": {
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": false
+      }
+    },
+    "git": {
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    },
+    "hooks": {
+      "before:init": [
+        "yarn install",
+        "yarn lint",
+        "yarn build",
+        "yarn test",
+        "yarn docs"
+      ],
+      "after:release": [
+        "yarn docs:deploy",
+        "echo Successfully released ${name} v${version} to ${repo.repository}."
+      ]
+    }
+  },
+  "volta": {
+    "node": "14.18.3",
+    "yarn": "1.22.17"
   }
 }