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

docs(contributing): add instructions to build Chromium revisions (#4246)

Browse Source
This commit is contained in:
Andrey Lushnikov 2019-04-04 15:34:41 -07:00 committed by GitHub
parent 67fbf46e8e
commit 080b80975f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
CONTRIBUTING.md
View File

@ -1,3 +1,21 @@
<!-- gen:toc -->
- [How to Contribute](#how-to-contribute)
* [Contributor License Agreement](#contributor-license-agreement)
* [Getting setup](#getting-setup)
* [Code reviews](#code-reviews)
* [Code Style](#code-style)
* [API guidelines](#api-guidelines)
* [Commit Messages](#commit-messages)
* [Writing Documentation](#writing-documentation)
* [Adding New Dependencies](#adding-new-dependencies)
* [Writing Tests](#writing-tests)
* [Public API Coverage](#public-api-coverage)
* [Debugging Puppeteer](#debugging-puppeteer)
- [For Project Maintainers](#for-project-maintainers)
* [Releasing to NPM](#releasing-to-npm)
* [Building Chromium Revisions](#building-chromium-revisions)
<!-- gen:stop -->
# How to Contribute
First of all, thank you for your interest in Puppeteer!
@ -199,7 +217,9 @@ npm run coverage
See [Debugging Tips](README.md#debugging-tips) in the readme.
## [For Project Maintainers] Releasing to NPM
# For Project Maintainers
## Releasing to NPM
Releasing to NPM consists of 3 phases:
1. Source Code: mark a release.
@ -224,3 +244,12 @@ Releasing to NPM consists of 3 phases:
- **NOTE**: make sure to update the "released APIs" section in the top of `docs/api.md`.
- **NOTE**: no other commits should be landed in-between release commit and bump commit.
## Building Chromium Revisions
Project maintainers with explicit access can request Chromium builds.
1. Goto [rpc explorer](https://cr-buildbucket.appspot.com/rpcexplorer/services/buildbucket.v2.Builds/ScheduleBuild?request={%20%20%20%20%22builder%22:%20{%20%20%20%20%20%20%20%20%22project%22:%20%22chromium%22,%20%20%20%20%20%20%20%20%22bucket%22:%20%22ci%22,%20%20%20%20%20%20%20%20%22builder%22:%20%22mac-rel%22%20%20%20%20},%20%20%20%20%22gitilesCommit%22:%20{%20%20%20%20%20%20%20%20%22host%22:%20%22chromium.googlesource.com%22,%20%20%20%20%20%20%20%20%22project%22:%20%22chromium/src%22,%20%20%20%20%20%20%20%20%22id%22:%20%22f6d8f73b94d1715b64f621d2112fbcecd0fc860a%22,%20%20%20%20%20%20%20%20%22ref%22:%20%22refs/heads/master%22%20%20%20%20},%20%20%20%20%22requestId%22:%20%22random%20string%20i%20guess%22})
2. Login with Google account
3. Set "builder" to either "mac-rel", "linux-rel", "win32-rel" or "win-rel"
4. Set "id" to the full SHA of the commit to be built
5. Hit "Send"

3
utils/doclint/cli.js
View File

@ -38,9 +38,10 @@ async function run() {
// Documentation checks.
{
const readme = await Source.readFile(path.join(PROJECT_DIR, 'README.md'));
const contributing = await Source.readFile(path.join(PROJECT_DIR, 'CONTRIBUTING.md'));
const api = await Source.readFile(path.join(PROJECT_DIR, 'docs', 'api.md'));
const troubleshooting = await Source.readFile(path.join(PROJECT_DIR, 'docs', 'troubleshooting.md'));
const mdSources = [readme, api, troubleshooting];
const mdSources = [readme, api, troubleshooting, contributing];
const preprocessor = require('./preprocessor');
messages.push(...await preprocessor.runCommands(mdSources, VERSION));