1
- # Release
1
+ # Release Process
2
2
3
3
Releases are mostly automated using
4
4
[ release-it] ( https://github.com/release-it/release-it/ ) and
5
5
[ lerna-changelog] ( https://github.com/lerna/lerna-changelog/ ) .
6
6
7
-
8
7
## Preparation
9
8
10
9
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:
25
24
* internal - Used for internal changes that still require a mention in the
26
25
changelog/release notes.
27
26
28
-
29
27
## Release
30
28
31
29
Once the prep work is completed, the actual release is straight forward:
32
30
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:
35
32
33
+ ``` sh
34
+ yarn install
36
35
```
37
- # using https://volta.sh
38
- volta install release-it
39
36
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.
42
41
43
- # using npm
44
- npm install --global release-it
45
- ```
42
+ For instance:
46
43
47
- * Second, ensure that you have installed your projects dependencies:
44
+ ``` bash
45
+ export GITHUB_AUTH=abc123def456
46
+ ```
48
47
49
- ```
50
- yarn install
51
- ```
48
+ [ generate-token ] : https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
52
49
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.
57
51
58
- ```
59
- export GITHUB_AUTH="f941e0..."
60
- release-it
52
+ ``` sh
53
+ npx release-it
61
54
```
62
55
63
56
[ release-it] ( https://github.com/release-it/release-it/ ) manages the actual
0 commit comments