Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
update release instructions
  • Loading branch information
searls committed Aug 23, 2021
1 parent 14de73c commit 226d09e
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions RELEASE.md
Expand Up @@ -15,17 +15,13 @@ $ echo $?
This should pass within a couple minutes and print 0 afterward, indicating it exited
cleanly.

Additionally, make sure you have [github_changelog_generator](https://github.com/skywinder/github-changelog-generator)
installed (`gem install github_changelog_generator`), which we use to automatically generate CHANGELOG.md mid-release

## Pre-flight checklist

Before releasing, make sure:

- [ ] You're on the `main` branch and have a clean working directory
- [ ] It's in sync with `origin/main` (e.g `git pull` status indicates up-to-date)
- [ ] `npm run test:ci` passes
- [ ] `which github_changelog_generator` is present on your PATH

## Publishing a release:

Expand All @@ -35,7 +31,7 @@ To publish a release, just bump the appropriate version segment:
$ npm version patch #<-- or "minor" or "major"
```

This will run a full build, tag the release, push everything to github, generate a changelog, and publish to npm.
This will run a full build, tag the release, push everything to github, update CHANGELOG.md, and publish to npm.

## If something goes wrong

Expand Down

0 comments on commit 226d09e

Please sign in to comment.