Skip to content

Commit

Permalink
Update release automation setup.
Browse files Browse the repository at this point in the history
  • Loading branch information
rwjblue committed May 26, 2020
1 parent 429eb1d commit 61dabd8
Show file tree
Hide file tree
Showing 3 changed files with 238 additions and 630 deletions.
18 changes: 10 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ have been merged since the last release have been labeled with the appropriate
represent something that would make sense to our users. Some great information
on why this is important can be found at
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
guiding principles here is that changelogs are for humans, not machines.
guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

Expand Down Expand Up @@ -47,19 +47,21 @@ npm install --global release-it
* Second, ensure that you have installed your projects dependencies:

```
# using yarn
yarn install
# using npm
npm install
```

* And last (but not least 😁) do your release:
* And last (but not least 😁) do your release. It requires a
[GitHub personal access token](https://github.com/settings/tokens) as
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin"
or other scopes are required.

```
export GITHUB_AUTH="f941e0..."
release-it
```

[release-it](https://github.com/release-it/release-it/) manages the actual
release process. It will prompt you through the process of choosing the version
number, tagging, pushing the tag and commits, etc.
release process. It will prompt you to to choose the version number after which
you will have the chance to hand tweak the changelog to be used (for the
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
pushing the tag and commits, etc.
10 changes: 6 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
"lerna-changelog": "^1.0.0",
"mocha": "^7.0.1",
"prettier": "^1.19.1",
"release-it": "^12.4.3",
"release-it-lerna-changelog": "^2.0.0",
"release-it": "^13.6.0",
"release-it-lerna-changelog": "^2.3.0",
"rimraf": "^3.0.1",
"tmp": "^0.2.1"
},
Expand All @@ -61,14 +61,16 @@
"release-it": {
"plugins": {
"release-it-lerna-changelog": {
"infile": "CHANGELOG.md"
"infile": "CHANGELOG.md",
"launchEditor": true
}
},
"git": {
"tagName": "v${version}"
},
"github": {
"release": true
"release": true,
"tokenRef": "GITHUB_AUTH"
}
}
}
Loading

0 comments on commit 61dabd8

Please sign in to comment.