@@ -14,7 +14,7 @@ have been merged since the last release have been labeled with the appropriate
1414represent something that would make sense to our users. Some great information
1515on why this is important can be found at
1616[ 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.
1818
1919When reviewing merged PR's the labels to be used are:
2020
@@ -47,19 +47,21 @@ npm install --global release-it
4747* Second, ensure that you have installed your projects dependencies:
4848
4949```
50- # using yarn
5150yarn install
52-
53- # using npm
54- npm install
5551```
5652
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.
5857
5958```
59+ export GITHUB_AUTH="f941e0..."
6060release-it
6161```
6262
6363[ 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