1- # Release
1+ # Release Process
22
33Releases 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
109Since 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
3129Once 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
0 commit comments