Skip to content

Commit

Permalink
update release process in MAINTAINERS.md
Browse files Browse the repository at this point in the history
We want to fast-forward the `mochajs.org` branch _before_ running `npm publish`
or people might look at out-of-date docs

Signed-off-by: Christopher Hiller <[email protected]>
  • Loading branch information
boneskull committed Jun 10, 2020
1 parent fc618a1 commit e0e6568
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,16 +347,14 @@ _It's easier to release often._
1. Push `master` to `origin` with your new tag; e.g. `git push origin master --tags`
1. Copy & paste the `CHANGELOG.md` lines to a new GitHub "release". Save release as draft.
1. Meanwhile, you can check [the build](https://travis-ci.org/mochajs/mocha) on Travis-CI and [AppVeyor](https://ci.appveyor.com/project/boneskull/mocha).
1. Once the build is green, and you're satisfied with the release notes, open your draft release on GitHub, then click "publish."
1. Once the build is green, you'll want to trigger an update of `mochajs.org`:
1. _If you're doing a prerelease_, fast-forward the `next` branch to `master`, and push it. This updates [https://next.mochajs.org](https://next.mochajs.org). That's all.
1. _If this is NOT a prerelease_, fast-forward the `mochajs.org` branch to `master` and push it. This updates [https://mochajs.org](https://mochajs.org).
1. _If this is a "final" release_ (the first release of a major _after_ one or more prereleases) then remove the `next` tag from npm via `npm dist-tag rm next`.
1. Finally, you're satisfied with the release notes, open your draft release on GitHub, then click "publish."
1. Back in your working copy, run `npm publish`. _If you're doing a prerelease, ensure that you use `--tag=next`._
1. Announce the update on Twitter or just tell your dog or something. New releases will be automatically tweeted by [@b0neskull](https://twitter.com/b0neskull) via a feed subscription to Mocha's "releases" page on GitHub.

In addition to above, you'll need to ensure the docs at [https://mochajs.org](https://mochajs.org) are updated:

1. _If you're doing a prerelease_, fast-forward the `next` branch to `master`, and push it. This updates [https://next.mochajs.org](https://next.mochajs.org). That's all.
1. _If this is NOT a prerelease_, fast-forward the `mochajs.org` branch to `master` and push it. This updates [https://mochajs.org](https://mochajs.org).
1. _If this is a "final" release_ (the first release of a major _after_ one or more prereleases) then remove the `next` tag from npm via `npm dist-tag rm next`.

_Note: there are too many steps above._

## About The JS Foundation
Expand Down

0 comments on commit e0e6568

Please sign in to comment.