Skip to content

Commit 52ff444

Browse files
author
Robert Jackson
committed
Update release documentation.
1 parent 6815a07 commit 52ff444

File tree

2 files changed

+19
-27
lines changed

2 files changed

+19
-27
lines changed

RELEASE.md

Lines changed: 16 additions & 27 deletions
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,43 +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+
npm 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-
# using yarn
51-
yarn install
48+
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
5249

53-
# using npm
54-
npm install
55-
```
50+
* And last (but not least 😁) do your release.
5651

57-
* And last (but not least 😁) do your release. It requires a
58-
[GitHub personal access token](https://github.com/settings/tokens) as
59-
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
60-
or other scopes are required.
61-
62-
```
63-
export GITHUB_AUTH="f941e0..."
64-
release-it
52+
```sh
53+
npx release-it
6554
```
6655

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

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@
5858
"uuid": "^8.3.1",
5959
"walk-sync": "^2.2.0"
6060
},
61+
"publishConfig": {
62+
"registry": "https://registry.npmjs.org"
63+
},
6164
"release-it": {
6265
"hooks": {
6366
"after:bump": "npm run build"

0 commit comments

Comments
 (0)