From b6ae3ddc967508372ab9add5c958fa82eb6650de Mon Sep 17 00:00:00 2001 From: Mathias Bynens Date: Tue, 10 Sep 2019 22:15:45 +0200 Subject: [PATCH] docs(CONTRIBUTING.md): clarify release process (#4923) After bumping the package.json version number, maintainers should run `npm run doc` to automatically update README.md and docs/api.md accordingly. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ec7e2e051574..8fdacb0ec6fd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -238,7 +238,7 @@ See [Debugging Tips](README.md#debugging-tips) in the readme. Releasing to npm consists of the following phases: 1. Source Code: mark a release. - 1. Bump `package.json` version following the SEMVER rules and send a PR titled `'chore: mark version vXXX.YYY.ZZZ'` ([example](https://github.com/GoogleChrome/puppeteer/commit/808bf8e5582482a1d849ff22a51e52024810905c)). + 1. Bump `package.json` version following the SEMVER rules, run `npm run doc` to update the docs accordingly, and send a PR titled `'chore: mark version vXXX.YYY.ZZZ'` ([example](https://github.com/GoogleChrome/puppeteer/commit/808bf8e5582482a1d849ff22a51e52024810905c)). 2. Make sure the PR passes **all checks**. - **WHY**: there are linters in place that help to avoid unnecessary errors, e.g. [like this](https://github.com/GoogleChrome/puppeteer/pull/2446) 3. Merge the PR.