Skip to content

Commit 60d700d

Browse files
author
Robert Jackson
committed
Add release-it setup.
1 parent fae7eab commit 60d700d

4 files changed

Lines changed: 1114 additions & 46 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Change Log
2-
31
## v2.0.0 (2018-10-29)
42

53
#### :boom: Breaking Change

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: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,34 @@
55
"keywords": [
66
"ember-addon"
77
],
8+
"homepage": "https://github.com/ember-cli/ember-load-initializers#readme",
9+
"bugs": {
10+
"url": "https://github.com/ember-cli/ember-load-initializers/issues"
11+
},
812
"repository": {
913
"type": "git",
1014
"url": "git+https://github.com/ember-cli/ember-load-initializers.git"
1115
},
1216
"license": "MIT",
13-
"directories": {
14-
"doc": "doc",
15-
"test": "tests"
16-
},
17-
"homepage": "https://github.com/ember-cli/ember-load-initializers#readme",
18-
"bugs": {
19-
"url": "https://github.com/ember-cli/ember-load-initializers/issues"
20-
},
2117
"contributors": [
2218
"Stefan Penner <stefan.penner@gmail.com>",
2319
"Mattia Gheda <ghedamat@gmail.com>",
2420
"Manuel Wiedenmann <manuel@funkensturm.de>",
2521
"Alex Navasardyan <alex@dockyard.com>"
2622
],
2723
"main": "index.js",
28-
"engines": {
29-
"node": "6.* || 8.* || >= 10.*"
24+
"directories": {
25+
"doc": "doc",
26+
"test": "tests"
3027
},
3128
"scripts": {
3229
"build": "ember build",
3330
"lint:js": "eslint .",
31+
"prepublishOnly": "ember ts:precompile",
32+
"postpublish": "ember ts:clean",
3433
"start": "ember serve",
3534
"test": "ember test",
36-
"test:all": "ember try:each",
37-
"prepublishOnly": "ember ts:precompile",
38-
"postpublish": "ember ts:clean"
35+
"test:all": "ember try:each"
3936
},
4037
"dependencies": {
4138
"ember-cli-babel": "^7.10.0",
@@ -70,9 +67,30 @@
7067
"eslint-plugin-node": "^8.0.0",
7168
"lerna-changelog": "^0.8.2",
7269
"loader.js": "^4.7.0",
70+
"release-it": "^12.2.1",
71+
"release-it-lerna-changelog": "^1.0.3",
7372
"typescript": "^3.3.3333"
7473
},
74+
"engines": {
75+
"node": "6.* || 8.* || >= 10.*"
76+
},
77+
"publishConfig": {
78+
"registry": "https://registry.npmjs.org"
79+
},
7580
"ember-addon": {
7681
"configPath": "tests/dummy/config"
82+
},
83+
"release-it": {
84+
"plugins": {
85+
"release-it-lerna-changelog": {
86+
"infile": "CHANGELOG.md"
87+
}
88+
},
89+
"git": {
90+
"tagName": "v${version}"
91+
},
92+
"github": {
93+
"release": true
94+
}
7795
}
7896
}

0 commit comments

Comments
 (0)