Skip to content

Commit eaecc2a

Browse files
author
Robert Jackson
committed
Address review comments.
1 parent 7c94995 commit eaecc2a

File tree

6 files changed

+526
-79
lines changed

6 files changed

+526
-79
lines changed
File renamed without changes.
File renamed without changes.

packages/ember-cli-code-coverage/RELEASE.md renamed to RELEASE.md

+16-23
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# Release
1+
# Release Process
22

33
Releases are mostly automated using
44
[release-it](https://github.com/release-it/release-it/) and
55
[lerna-changelog](https://github.com/lerna/lerna-changelog/).
66

7-
87
## Preparation
98

109
Since the majority of the actual release process is automated, the primary
@@ -25,39 +24,33 @@ When reviewing merged PR's the labels to be used are:
2524
* internal - Used for internal changes that still require a mention in the
2625
changelog/release notes.
2726

28-
2927
## Release
3028

3129
Once the prep work is completed, the actual release is straight forward:
3230

33-
* First ensure that you have `release-it` installed globally, generally done by
34-
using one of the following commands:
31+
* First, ensure that you have installed your projects dependencies:
3532

33+
```sh
34+
yarn install
3635
```
37-
# using https://volta.sh
38-
volta install release-it
3936

40-
# using Yarn
41-
yarn global add release-it
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.
4241

43-
# using npm
44-
npm install --global release-it
45-
```
42+
For instance:
4643

47-
* Second, ensure that you have installed your projects dependencies:
44+
```bash
45+
export GITHUB_AUTH=abc123def456
46+
```
4847

49-
```
50-
yarn install
51-
```
48+
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
5249

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.
50+
* And last (but not least 😁) do your release.
5751

58-
```
59-
export GITHUB_AUTH="f941e0..."
60-
release-it
52+
```sh
53+
npx release-it
6154
```
6255

6356
[release-it](https://github.com/release-it/release-it/) manages the actual

package.json

+48-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"private": true,
3+
"repository": {
4+
"type": "git",
5+
"url": "[email protected]:kategengler/ember-cli-code-coverage.git"
6+
},
37
"workspaces": [
48
"packages/*",
59
"test-packages/*"
@@ -12,6 +16,49 @@
1216
"chai-files": "^1.4.0",
1317
"execa": "^4.0.3",
1418
"mocha": "^5.2.0",
19+
"release-it": "^14.0.2",
20+
"release-it-lerna-changelog": "^2.4.0",
21+
"release-it-yarn-workspaces": "^1.5.0",
1522
"rimraf": "^2.6.2"
23+
},
24+
"publishConfig": {
25+
"registry": "https://registry.npmjs.org"
26+
},
27+
"changelog": {
28+
"repo": "kategengler/ember-cli-code-coverage",
29+
"labels": {
30+
"breaking": ":boom: Breaking Change",
31+
"enhancement": ":rocket: Enhancement",
32+
"bug": ":bug: Bug Fix",
33+
"documentation": ":memo: Documentation",
34+
"internal": ":house: Internal"
35+
}
36+
},
37+
"release-it": {
38+
"plugins": {
39+
"release-it-lerna-changelog": {
40+
"infile": "CHANGELOG.md",
41+
"launchEditor": true
42+
},
43+
"release-it-yarn-workspaces": {
44+
"additionalManifests": {
45+
"dependencyUpdates": [
46+
"test-packages/*/package.json"
47+
]
48+
},
49+
"publish": false,
50+
"workspaces": [
51+
"packages/*"
52+
]
53+
}
54+
},
55+
"git": {
56+
"tagName": "v${version}"
57+
},
58+
"github": {
59+
"release": true,
60+
"tokenRef": "GITHUB_AUTH"
61+
},
62+
"npm": false
1663
}
17-
}
64+
}

packages/ember-cli-code-coverage/package.json

+1-29
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"browser-test": "COVERAGE=true ember test",
2626
"lint:hbs": "ember-template-lint .",
2727
"lint:js": "eslint .",
28-
"test": "npm run-script lint:js && npm run-script node-test"
28+
"test": "npm run lint:js"
2929
},
3030
"dependencies": {
3131
"babel-plugin-istanbul": "^6.0.0",
@@ -83,39 +83,11 @@
8383
"publishConfig": {
8484
"registry": "https://registry.npmjs.org"
8585
},
86-
"changelog": {
87-
"repo": "kategengler/ember-cli-code-coverage",
88-
"labels": {
89-
"breaking": ":boom: Breaking Change",
90-
"enhancement": ":rocket: Enhancement",
91-
"bug": ":bug: Bug Fix",
92-
"documentation": ":memo: Documentation",
93-
"internal": ":house: Internal"
94-
}
95-
},
9686
"ember": {
9787
"edition": "octane"
9888
},
9989
"ember-addon": {
10090
"configPath": "tests/dummy/config",
10191
"before": "ember-cli-typescript"
102-
},
103-
"release-it": {
104-
"plugins": {
105-
"release-it-lerna-changelog": {
106-
"infile": "CHANGELOG.md",
107-
"launchEditor": true
108-
}
109-
},
110-
"git": {
111-
"tagName": "v${version}"
112-
},
113-
"github": {
114-
"release": true,
115-
"tokenRef": "GITHUB_AUTH"
116-
},
117-
"npm": {
118-
"publish": false
119-
}
12092
}
12193
}

0 commit comments

Comments
 (0)