@@ -14,7 +14,7 @@ have been merged since the last release have been labeled with the appropriate
14
14
represent something that would make sense to our users. Some great information
15
15
on why this is important can be found at
16
16
[ keepachangelog.com] ( https://keepachangelog.com/en/1.0.0/ ) , but the overall
17
- guiding principles here is that changelogs are for humans, not machines.
17
+ guiding principle here is that changelogs are for humans, not machines.
18
18
19
19
When reviewing merged PR's the labels to be used are:
20
20
@@ -47,19 +47,21 @@ npm install --global release-it
47
47
* Second, ensure that you have installed your projects dependencies:
48
48
49
49
```
50
- # using yarn
51
50
yarn install
52
-
53
- # using npm
54
- npm install
55
51
```
56
52
57
- * And last (but not least 😁) do your release:
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.
58
57
59
58
```
59
+ export GITHUB_AUTH="f941e0..."
60
60
release-it
61
61
```
62
62
63
63
[ 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.
64
+ release process. It will prompt you to to choose the version number after which
65
+ you will have the chance to hand tweak the changelog to be used (for the
66
+ ` CHANGELOG.md ` and GitHub release), then ` release-it ` continues on to tagging,
67
+ pushing the tag and commits, etc.
0 commit comments