Skip to content

Commit 66befe5

Browse files
committed
Add release-it setup.
1 parent a01b63a commit 66befe5

File tree

4 files changed

+2734
-4
lines changed

4 files changed

+2734
-4
lines changed

CHANGELOG.md

Whitespace-only changes.

RELEASE.md

+65
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

+21-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,31 @@
22
"name": "@ember/edition-utils",
33
"version": "1.0.0",
44
"description": "Utilities to detect if a given edition is in use in an ember-cli application.",
5+
"license": "MIT",
6+
"author": "Robert Jackson <me@rwjblue.com>",
57
"main": "index.js",
68
"scripts": {
79
"test": "qunit test.js"
810
},
9-
"author": "Robert Jackson <me@rwjblue.com>",
10-
"license": "MIT",
1111
"devDependencies": {
12-
"qunit": "^2.9.2"
12+
"qunit": "^2.9.2",
13+
"release-it": "^12.2.1",
14+
"release-it-lerna-changelog": "^1.0.3"
15+
},
16+
"publishConfig": {
17+
"registry": "https://registry.npmjs.org"
18+
},
19+
"release-it": {
20+
"plugins": {
21+
"release-it-lerna-changelog": {
22+
"infile": "CHANGELOG.md"
23+
}
24+
},
25+
"git": {
26+
"tagName": "v${version}"
27+
},
28+
"github": {
29+
"release": true
30+
}
1331
}
1432
}

0 commit comments

Comments
 (0)