Skip to content

Commit 1fc0d23

Browse files
author
Robert Jackson
committed
Update release process documentation.
1 parent 93d57c2 commit 1fc0d23

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

RELEASE.md

+27-3
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,36 @@ When reviewing merged PR's the labels to be used are:
3030

3131
Once the prep work is completed, the actual release is straight forward:
3232

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+
3349
```
50+
# using yarn
3451
yarn install
35-
yarn release
52+
53+
# using npm
54+
npm install
55+
```
56+
57+
* And last (but not least 😁) do your release:
58+
59+
```
60+
release-it
3661
```
3762

38-
The `release` script leverages
39-
[release-it](https://github.com/release-it/release-it/) to do the mechanical
63+
[release-it](https://github.com/release-it/release-it/) manages the actual
4064
release process. It will prompt you through the process of choosing the version
4165
number, tagging, pushing the tag and commits, etc.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
"update-docs": "codemod-cli update-docs"
3636
},
3737
"dependencies": {
38-
"ember-codemods-telemetry-helpers": "^0.5.0",
3938
"codemod-cli": "^2.0.0",
39+
"ember-codemods-telemetry-helpers": "^0.5.0",
4040
"fs-extra": "^8.0.1",
4141
"git-repo-info": "^2.1.0",
4242
"minimatch": "^3.0.4",
@@ -63,7 +63,7 @@
6363
},
6464
"release-it": {
6565
"hooks": {
66-
"before:release": "yarn update-docs"
66+
"after:bump": "yarn update-docs"
6767
},
6868
"plugins": {
6969
"release-it-lerna-changelog": {

0 commit comments

Comments
 (0)