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
@@ -14,7 +13,7 @@ have been merged since the last release have been labeled with the appropriate
1413represent something that would make sense to our users. Some great information
1514on why this is important can be found at
1615[ keepachangelog.com] ( https://keepachangelog.com/en/1.0.0/ ) , but the overall
17- guiding principles here is that changelogs are for humans, not machines.
16+ guiding principle here is that changelogs are for humans, not machines.
1817
1918When reviewing merged PR's the labels to be used are:
2019
@@ -25,41 +24,37 @@ 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- # using yarn
51- yarn install
52-
53- # using npm
54- npm install
55- ```
48+ [ generate-token ] : https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
5649
57- * And last (but not least 😁) do your release:
50+ * And last (but not least 😁) do your release.
5851
59- ```
60- release-it
52+ ``` sh
53+ npx release-it
6154```
6255
6356[ release-it] ( https://github.com/release-it/release-it/ ) manages the actual
64- release process. It will prompt you through the process of choosing the version
65- number, tagging, pushing the tag and commits, etc.
57+ release process. It will prompt you to to choose the version number after which
58+ you will have the chance to hand tweak the changelog to be used (for the
59+ ` CHANGELOG.md ` and GitHub release), then ` release-it ` continues on to tagging,
60+ pushing the tag and commits, etc.
0 commit comments