Skip to content

Commit ba30c9f

Browse files
Add rwjblue release-it config
1 parent 61eec43 commit ba30c9f

File tree

4 files changed

+2050
-35
lines changed

4 files changed

+2050
-35
lines changed

CHANGELOG.md

Whitespace-only changes.

RELEASE.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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 principle 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+
yarn install
51+
```
52+
53+
* And last (but not least 😁) do your release. It requires a
54+
[GitHub personal access token](https://github.com/settings/tokens) as
55+
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
56+
or other scopes are required.
57+
58+
```
59+
export GITHUB_AUTH="f941e0..."
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 to to choose the version number after which
65+
you will have the chance to hand tweak the changelog to be used (for the
66+
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
67+
pushing the tag and commits, etc.

package.json

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,32 @@
5252
"eslint-plugin-node": "^9.0.1",
5353
"fs-extra": "^8.0.1",
5454
"loader.js": "^4.7.0",
55-
"qunit-dom": "^0.8.4"
55+
"qunit-dom": "^0.8.4",
56+
"release-it": "^13.6.0",
57+
"release-it-lerna-changelog": "^2.3.0"
5658
},
5759
"engines": {
5860
"node": "8.* || >= 10.*"
5961
},
62+
"publishConfig": {
63+
"registry": "https://registry.npmjs.org"
64+
},
6065
"ember-addon": {
6166
"configPath": "tests/dummy/config"
67+
},
68+
"release-it": {
69+
"plugins": {
70+
"release-it-lerna-changelog": {
71+
"infile": "CHANGELOG.md",
72+
"launchEditor": false
73+
}
74+
},
75+
"git": {
76+
"tagName": "v${version}"
77+
},
78+
"github": {
79+
"release": true,
80+
"tokenRef": "GITHUB_AUTH"
81+
}
6282
}
6383
}

0 commit comments

Comments
 (0)