Skip to content

Commit ab73d00

Browse files
author
Robert Jackson
committed
Add automated release setup.
1 parent 7e3bd6c commit ab73d00

File tree

4 files changed

+2318
-28
lines changed

4 files changed

+2318
-28
lines changed

CHANGELOG.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# ember-truth-helpers Changelog
2-
31
### v2.1.0 (2018-08-20)
42
- Add `is-empty` helper
53

RELEASE.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Release Process
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+
## Preparation
8+
9+
Since the majority of the actual release process is automated, the primary
10+
remaining task prior to releasing is confirming that all pull requests that
11+
have been merged since the last release have been labeled with the appropriate
12+
`lerna-changelog` labels and the titles have been updated to ensure they
13+
represent something that would make sense to our users. Some great information
14+
on why this is important can be found at
15+
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
16+
guiding principle here is that changelogs are for humans, not machines.
17+
18+
When reviewing merged PR's the labels to be used are:
19+
20+
* breaking - Used when the PR is considered a breaking change.
21+
* enhancement - Used when the PR adds a new feature or enhancement.
22+
* bug - Used when the PR fixes a bug included in a previous release.
23+
* documentation - Used when the PR adds or updates documentation.
24+
* internal - Used for internal changes that still require a mention in the
25+
changelog/release notes.
26+
27+
## Release
28+
29+
Once the prep work is completed, the actual release is straight forward:
30+
31+
* First, ensure that you have installed your projects dependencies:
32+
33+
```sh
34+
yarn install
35+
```
36+
37+
* Second, ensure that you have obtained a
38+
[GitHub personal access token][generate-token] with the `repo` scope (no
39+
other permissions are needed). Make sure the token is available as the
40+
`GITHUB_AUTH` environment variable.
41+
42+
For instance:
43+
44+
```bash
45+
export GITHUB_AUTH=abc123def456
46+
```
47+
48+
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
49+
50+
* And last (but not least 😁) do your release.
51+
52+
```sh
53+
npx release-it
54+
```
55+
56+
[release-it](https://github.com/release-it/release-it/) manages the actual
57+
release process. It will prompt you to to choose the version number after which
58+
you will have the chance to hand tweak the changelog to be used (for the
59+
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
60+
pushing the tag and commits, etc.

package.json

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,32 @@
4747
"eslint-plugin-ember": "^5.2.0",
4848
"eslint-plugin-node": "^7.0.1",
4949
"loader.js": "^4.7.0",
50-
"qunit-dom": "^0.8.0"
50+
"qunit-dom": "^0.8.0",
51+
"release-it": "^14.0.2",
52+
"release-it-lerna-changelog": "^2.4.0"
5153
},
5254
"engines": {
5355
"node": "10.* || >= 12.*"
5456
},
57+
"publishConfig": {
58+
"registry": "https://registry.npmjs.org"
59+
},
5560
"ember-addon": {
5661
"configPath": "tests/dummy/config"
62+
},
63+
"release-it": {
64+
"plugins": {
65+
"release-it-lerna-changelog": {
66+
"infile": "CHANGELOG.md",
67+
"launchEditor": true
68+
}
69+
},
70+
"git": {
71+
"tagName": "v${version}"
72+
},
73+
"github": {
74+
"release": true,
75+
"tokenRef": "GITHUB_AUTH"
76+
}
5777
}
5878
}

0 commit comments

Comments
 (0)