@@ -30,34 +30,29 @@ When reviewing merged PR's the labels to be used are:
30
30
31
31
Once the prep work is completed, the actual release is straight forward:
32
32
33
- * First ensure that you have ` release-it ` installed globally, generally done by
34
- using one of the following commands:
33
+ * First, ensure that you have installed your projects dependencies:
35
34
36
35
```
37
- # using https://volta.sh
38
- volta install release-it
36
+ yarn install
37
+ ```
39
38
40
- # using Yarn
41
- yarn global add release-it
39
+ * Second, ensure that you have obtained a
40
+ [ GitHub personal access token] [ generate-token ] with the ` repo ` scope (no
41
+ other permissions are needed). Make sure the token is available as the
42
+ ` GITHUB_AUTH ` environment variable.
42
43
43
- # using npm
44
- npm install --global release-it
45
- ```
44
+ For instance:
46
45
47
- * Second, ensure that you have installed your projects dependencies:
46
+ ``` bash
47
+ export GITHUB_AUTH=abc123def456
48
+ ```
48
49
49
- ```
50
- yarn install
51
- ```
50
+ [ generate-token ] : https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
52
51
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.
52
+ * And last (but not least 😁) do your release.
57
53
58
54
```
59
- export GITHUB_AUTH="f941e0..."
60
- release-it
55
+ npx release-it
61
56
```
62
57
63
58
[ release-it] ( https://github.com/release-it/release-it/ ) manages the actual
0 commit comments