You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: MAINTAINERS.md
+15-5
Original file line number
Diff line number
Diff line change
@@ -338,14 +338,24 @@ By using milestones, we can cherry-pick non-breaking changes into minor or patch
338
338
339
339
1. Decide whether this is a `patch`, `minor`, or `major` release.
340
340
1. Checkout `master` in your working copy & pull.
341
-
1. Modify `CHANGELOG.md`; follow the existing conventions in that file. Commit this file only; add `[ci skip]` to the commit message to avoid a build.
341
+
1. Modify `CHANGELOG.md`; follow the existing conventions in that file. Use the "pull request" number, unless there isn't one. *You do not need to add Markdown links; this is done automatically.*
342
+
1. You can omit stuff from `CHANGELOG.md` that was done by a maintainer, but would have no interest to consumers of Mocha.
343
+
1. If the changes aren't of interest to consumers but *were not* made by a maintainer, reference them anyway. It's cool to give attribution!
342
344
1. Use `npm version` (use `npm@6+`) to bump the version; see `npm version --help` for more info. (Hint--use `-m`: e.g., `npm version patch -m 'Release v%s'`)
345
+
1. This command will update the list of contributors (from the Git history) in `package.json`, and add GitHub links to `CHANGELOG.md`.
346
+
1. These changes are then added to the Git "stage" and will be added to the commit.
343
347
1. Push `master` to `origin` with your new tag; e.g. `git push origin master --tags`
344
-
1. Copy & paste the added lines to a new GitHub "release". Be sure to add any missing link references (use "preview" button). Save release as draft.
345
-
1. Meanwhile, you can check [the build](https://travis-ci.org/mochajs/mocha) on Travis-CI.
348
+
1. Copy & paste the `CHANGELOG.md` lines to a new GitHub "release". Save release as draft.
349
+
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).
346
350
1. Once the build is green, and you're satisfied with the release notes, open your draft release on GitHub, then click "publish."
347
-
1. Back in your working copy, run `npm publish`.
348
-
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).
351
+
1. Back in your working copy, run `npm publish`. *If you're doing a prerelease, ensure that you use `--tag=next`.*
352
+
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.
353
+
354
+
In addition to above, you'll need to ensure the docs at [https://mochajs.org](https://mochajs.org) are updated:
355
+
356
+
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.
357
+
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).
358
+
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`.
0 commit comments