docs(CONTRIBUTING.md): fix some typos #4917
Conversation
|
|
||
| Releasing to NPM consists of 3 phases: |
There was a problem hiding this comment.
I'm assuming the number wasn't updated when the fourth phase was added.
|
|
||
| For both `puppeteer` and `puppeteer-firefox` we maintain the following NPM Tags: |
There was a problem hiding this comment.
I think puppeteer-firefox was a typo here, and puppeteer-core is what was meant.
|
|
||
| Releasing to NPM consists of 3 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)). |
There was a problem hiding this comment.
Drive-by question: are PRs like this created manually? I'm asking because the <!-- GEN:empty-if-release -->-style comments imply otherwise.
There was a problem hiding this comment.
These PRs are created manually, but the <!-- GEN:empty-if-release --> are updated with our markdown preprocessor.
There was a problem hiding this comment.
Thanks! I'll submit a follow-up CL that explicitly calls out that one needs to run npm run doc after bumping the package.json version number.
|
Thanks! |
|
|
||
| Releasing to NPM consists of 3 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)). | ||
| 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. | ||
| 4. Once merged, publish release notes using the "create new tag" option. |
There was a problem hiding this comment.
the "create new tag" option
What is this referring to exactly? On https://github.com/GoogleChrome/puppeteer/releases I see a "Draft a new release" button -- is that what is meant?
Is there some tool or git log-based command-line script you're using for the release notes (example)?
As someone who's new to the project, I read the contributing guide and spotted some things that confused me. Hopefully this patch helps to reduces the confusion for others!
As someone who's new to the project, I read the contributing guide and spotted some things that confused me. Hopefully this patch helps to reduces the confusion for others!