Skip to content

Commit 2a26d8a

Browse files
author
Robert Jackson
committed
Add release-it setup.
1 parent 9aa00b5 commit 2a26d8a

File tree

5 files changed

+1980
-22
lines changed

5 files changed

+1980
-22
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ before_install:
1616
- export PATH=$HOME/.yarn/bin:$PATH
1717

1818
install:
19-
- yarn install
19+
- yarn install --ignore-engines
2020

2121
script:
2222
- yarn test

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: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"version": "1.2.0",
44
"description": "codemod script for ember-qunit",
55
"keywords": [
6-
"codemod-cli",
76
"codemod",
7+
"codemod-cli",
88
"qunit"
99
],
1010
"homepage": "https://github.com/ember-codemods/ember-qunit-codemod#readme",
@@ -31,9 +31,27 @@
3131
"eslint-config-prettier": "^4.0.0",
3232
"eslint-plugin-prettier": "^3.0.0",
3333
"jest": "^24.1.0",
34-
"prettier": "^1.13.5"
34+
"prettier": "^1.13.5",
35+
"release-it": "^12.2.1",
36+
"release-it-lerna-changelog": "^1.0.3"
3537
},
3638
"engines": {
3739
"node": ">=6"
40+
},
41+
"publishConfig": {
42+
"registry": "https://registry.npmjs.org"
43+
},
44+
"release-it": {
45+
"plugins": {
46+
"release-it-lerna-changelog": {
47+
"infile": "CHANGELOG.md"
48+
}
49+
},
50+
"git": {
51+
"tagName": "v${version}"
52+
},
53+
"github": {
54+
"release": true
55+
}
3856
}
3957
}

0 commit comments

Comments
 (0)