Merge pull request #114 from jrjohnson/release-process

Configure and document release process

Author: jrjohnson

RELEASE.md

@@ -0,0 +1,60 @@
+# 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
+```
+
+* 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,6 +2,13 @@
   "name": "ember-cli-deploy-s3-index",
   "version": "1.3.1",
   "description": "Ember CLI Deploy plugin to deploy ember-cli's bootstrap index file to S3.",
+  "keywords": [
+    "ember-addon",
+    "ember-cli-deploy-plugin"
+  ],
+  "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index",
+  "license": "MIT",
+  "author": "",
   "directories": {
     "doc": "doc",
     "test": "tests"
@@ -10,40 +17,42 @@
     "release": "release-it",
     "test": "node tests/runner.js && ./node_modules/.bin/eslint index.js lib/* tests/**/*.js"
   },
-  "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy-s3-index",
-  "engines": {
-    "node": "12.* || 14.* || >= 16"
+  "dependencies": {
+    "aws-sdk": "^2.667.0",
+    "core-object": "^3.0.0",
+    "ember-cli-deploy-plugin": "^0.2.9",
+    "mime-types": "^2.1.27",
+    "rsvp": "^4.8.5"
   },
-  "author": "",
-  "license": "MIT",
   "devDependencies": {
-    "github": "^0.2.4",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "ember-cli": "~3.18.0",
     "eslint": "^7.0.0",
     "glob": "^7.1.6",
     "mocha": "^7.1.2",
-    "release-it": "*"
+    "release-it": "^14.2.1",
+    "release-it-lerna-changelog": "^3.1.0"
   },
-  "keywords": [
-    "ember-addon",
-    "ember-cli-deploy-plugin"
-  ],
-  "dependencies": {
-    "aws-sdk": "^2.667.0",
-    "core-object": "^3.0.0",
-    "ember-cli-deploy-plugin": "^0.2.9",
-    "mime-types": "^2.1.27",
-    "rsvp": "^4.8.5"
+  "engines": {
+    "node": "12.* || 14.* || >= 16"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
   },
   "release-it": {
     "git": {
-      "changelog": "./bin/changelog",
       "requireCleanWorkingDir": false
     },
     "github": {
-      "release": true
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    },
+    "plugins": {
+      "release-it-lerna-changelog": {
+        "infile": "CHANGELOG.md",
+        "launchEditor": true
+      }
     }
   }
 }