github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update contributing (#9202)

Browse Source
This commit is contained in:
jrandolf 2022-11-03 11:08:36 +01:00 committed by GitHub
parent 30e5b1a58e
commit 641a326541
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/contributing.md
View File

@ -298,3 +298,27 @@ working tree to determine the range to bisect.
We use [release-please](https://github.com/googleapis/release-please) to We use [release-please](https://github.com/googleapis/release-please) to
automate releases. When a release should be done, check for the release PR in automate releases. When a release should be done, check for the release PR in
our [pull requests](https://github.com/puppeteer/puppeteer/pulls) and merge it. our [pull requests](https://github.com/puppeteer/puppeteer/pulls) and merge it.
### In case Release Please fails
<!-- TODO: Remove once release-please is fixed -->
In the event release-please fails, the following needs to be done:
1. Update anything missing in the CHANGELOG of every package that was supposed
to be published. For example, if the header is missing, you may need to add
- For puppeteer:
```md
## [{NEW_VERSION}](https://github.com/puppeteer/puppeteer/compare/v{PREVIOUS_VERSION}...v{NEW_VERSION}) ({CURRENT_DATE})`
```
- For other packages:
```md
## [{NEW_VERSION}](https://github.com/puppeteer/puppeteer/compare/{PACKAGE_FOLDER_NAME}-v{PREVIOUS_VERSION}...{PACKAGE_FOLDER_NAME}-v{NEW_VERSION}) ({CURRENT_DATE})
```
2. Create a GitHub release for each package, following the practice of previous
releases.