Skip to content

Commit 9e5687e

Browse files
committed
Add automated release setup, and document in RELEASE.md.
1 parent 74c1ed5 commit 9e5687e

File tree

3 files changed

+822
-44
lines changed

3 files changed

+822
-44
lines changed

RELEASE.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
```
34+
yarn install
35+
yarn release
36+
```
37+
38+
The `release` script leverages
39+
[release-it](https://github.com/release-it/release-it/) to do the mechanical
40+
release process. It will prompt you through the process of choosing the version
41+
number, tagging, pushing the tag and commits, etc.

package.json

+20-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"build": "ember build",
1717
"changelog": "lerna-changelog",
1818
"lint:js": "eslint .",
19+
"release": "release-it",
1920
"start": "ember serve",
2021
"test": "ember test",
2122
"test:all": "ember try:each"
@@ -53,15 +54,31 @@
5354
"eslint-plugin-node": "^8.0.1",
5455
"lerna-changelog": "^0.8.2",
5556
"loader.js": "^4.7.0",
56-
"qunit-dom": "^0.8.5"
57+
"qunit-dom": "^0.8.5",
58+
"release-it": "^12.2.1",
59+
"release-it-lerna-changelog": "^1.0.3"
5760
},
5861
"engines": {
5962
"node": "6.* || 8.* || >= 10.*"
6063
},
64+
"publishConfig": {
65+
"access": "public",
66+
"registry": "https://registry.npmjs.org"
67+
},
6168
"ember-addon": {
6269
"configPath": "tests/dummy/config"
6370
},
64-
"publishConfig": {
65-
"access": "public"
71+
"release-it": {
72+
"plugins": {
73+
"release-it-lerna-changelog": {
74+
"infile": "CHANGELOG.md"
75+
}
76+
},
77+
"git": {
78+
"tagName": "v${version}"
79+
},
80+
"github": {
81+
"release": true
82+
}
6683
}
6784
}

0 commit comments

Comments
 (0)