Skip to content

Commit 2812363

Browse files
author
Robert Jackson
committed
Add automated release setup.
1 parent f56d77f commit 2812363

4 files changed

Lines changed: 1577 additions & 54 deletions

File tree

CHANGELOG.md

Whitespace-only changes.

RELEASE.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Release
2+
3+
Releases are mostly automated using
4+
[release-it](https://github.com/release-it/release-it/) and
5+
[lerna-changelog](https://github.com/lerna/lerna-changelog/).
6+
7+
8+
## Preparation
9+
10+
Since the majority of the actual release process is automated, the primary
11+
remaining task prior to releasing is confirming that all pull requests that
12+
have been merged since the last release have been labeled with the appropriate
13+
`lerna-changelog` labels and the titles have been updated to ensure they
14+
represent something that would make sense to our users. Some great information
15+
on why this is important can be found at
16+
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
17+
guiding principles here is that changelogs are for humans, not machines.
18+
19+
When reviewing merged PR's the labels to be used are:
20+
21+
* breaking - Used when the PR is considered a breaking change.
22+
* enhancement - Used when the PR adds a new feature or enhancement.
23+
* bug - Used when the PR fixes a bug included in a previous release.
24+
* documentation - Used when the PR adds or updates documentation.
25+
* internal - Used for internal changes that still require a mention in the
26+
changelog/release notes.
27+
28+
29+
## Release
30+
31+
Once the prep work is completed, the actual release is straight forward:
32+
33+
* First ensure that you have `release-it` installed globally, generally done by
34+
using one of the following commands:
35+
36+
```
37+
# using https://volta.sh
38+
volta install release-it
39+
40+
# using Yarn
41+
yarn global add release-it
42+
43+
# using npm
44+
npm install --global release-it
45+
```
46+
47+
* Second, ensure that you have installed your projects dependencies:
48+
49+
```
50+
# using yarn
51+
yarn install
52+
53+
# using npm
54+
npm install
55+
```
56+
57+
* And last (but not least 😁) do your release:
58+
59+
```
60+
release-it
61+
```
62+
63+
[release-it](https://github.com/release-it/release-it/) manages the actual
64+
release process. It will prompt you through the process of choosing the version
65+
number, tagging, pushing the tag and commits, etc.

package.json

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
{
22
"name": "ember-cli-htmlbars-inline-precompile-codemod",
33
"version": "0.1.0",
4+
"keywords": [
5+
"codemod-cli"
6+
],
7+
"bin": "./bin/cli.js",
48
"scripts": {
9+
"coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls",
510
"lint": "eslint --cache .",
611
"test": "codemod-cli test",
712
"test:coverage": "codemod-cli test --coverage",
8-
"update-docs": "codemod-cli update-docs",
9-
"coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls"
13+
"update-docs": "codemod-cli update-docs"
14+
},
15+
"jest": {
16+
"testEnvironment": "node"
1017
},
11-
"bin": "./bin/cli.js",
12-
"keywords": [
13-
"codemod-cli"
14-
],
1518
"dependencies": {
1619
"codemod-cli": "^2.1.0"
1720
},
@@ -22,12 +25,27 @@
2225
"eslint-plugin-node": "^10.0.0",
2326
"eslint-plugin-prettier": "^3.1.1",
2427
"jest": "^24.9.0",
25-
"prettier": "^1.18.2"
28+
"prettier": "^1.18.2",
29+
"release-it": "^12.2.1",
30+
"release-it-lerna-changelog": "^1.0.3"
2631
},
2732
"engines": {
2833
"node": "8.* || 10.* || >= 12"
2934
},
30-
"jest": {
31-
"testEnvironment": "node"
35+
"publishConfig": {
36+
"registry": "https://registry.npmjs.org"
37+
},
38+
"release-it": {
39+
"plugins": {
40+
"release-it-lerna-changelog": {
41+
"infile": "CHANGELOG.md"
42+
}
43+
},
44+
"git": {
45+
"tagName": "v${version}"
46+
},
47+
"github": {
48+
"release": true
49+
}
3250
}
3351
}

0 commit comments

Comments
 (0)