Skip to content

Commit 61dabd8

Browse files
author
Robert Jackson
committed
Update release automation setup.
1 parent 429eb1d commit 61dabd8

File tree

3 files changed

+238
-630
lines changed

3 files changed

+238
-630
lines changed

RELEASE.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ have been merged since the last release have been labeled with the appropriate
1414
represent something that would make sense to our users. Some great information
1515
on 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

1919
When 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
5150
yarn 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..."
6060
release-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.

package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@
4747
"lerna-changelog": "^1.0.0",
4848
"mocha": "^7.0.1",
4949
"prettier": "^1.19.1",
50-
"release-it": "^12.4.3",
51-
"release-it-lerna-changelog": "^2.0.0",
50+
"release-it": "^13.6.0",
51+
"release-it-lerna-changelog": "^2.3.0",
5252
"rimraf": "^3.0.1",
5353
"tmp": "^0.2.1"
5454
},
@@ -61,14 +61,16 @@
6161
"release-it": {
6262
"plugins": {
6363
"release-it-lerna-changelog": {
64-
"infile": "CHANGELOG.md"
64+
"infile": "CHANGELOG.md",
65+
"launchEditor": true
6566
}
6667
},
6768
"git": {
6869
"tagName": "v${version}"
6970
},
7071
"github": {
71-
"release": true
72+
"release": true,
73+
"tokenRef": "GITHUB_AUTH"
7274
}
7375
}
7476
}

0 commit comments

Comments
 (0)