Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ jobs:
- uses: actions/checkout@v6
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: Install dependencies
run: npm ci
- uses: actions/setup-node@v6
with:
node-version-file: .nvmrc
cache: 'npm'
- name: Install dependencies
run: npm ci
# Workflows are not allowed to edit workflows. As result, we need to prevent Prettier from formatting them.
- name: Prevent workflows from being formatted
run: echo ".github" >> .prettierignore && cat .prettierignore
Expand Down
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,31 @@ npm run test:examples
npm run test:node
```

### Chrome Driver Configuration

Some tests require the Chrome Driver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing period at the end of the sentence. It should be "...from the npm registry." to maintain consistency with the rest of the documentation.

Copilot uses AI. Check for mistakes.

To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command has an unnecessary semicolon at the end. Shell commands typically don't need semicolons unless chaining multiple commands. Remove the semicolon for consistency with line 179.

Suggested change
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`

Copilot uses AI. Check for mistakes.

To get the Chrome Driver run: `npx @puppeteer/browsers install chromedriver`
Comment on lines +172 to +179
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent capitalization. "Chrome Driver" should be "ChromeDriver" to match the standard naming convention used elsewhere in the documentation and in the environment variable name CHROMEDRIVER_BIN.

Suggested change
### Chrome Driver Configuration
Some tests require the Chrome Driver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the Chrome Driver run: `npx @puppeteer/browsers install chromedriver`
### ChromeDriver Configuration
Some tests require the ChromeDriver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the ChromeDriver run: `npx @puppeteer/browsers install chromedriver`

Copilot uses AI. Check for mistakes.
Comment on lines +172 to +179
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent capitalization. "Chrome Driver" should be "ChromeDriver" to match the standard naming convention used elsewhere in the documentation and in the environment variable name CHROMEDRIVER_BIN.

Suggested change
### Chrome Driver Configuration
Some tests require the Chrome Driver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the Chrome Driver run: `npx @puppeteer/browsers install chromedriver`
### ChromeDriver Configuration
Some tests require the ChromeDriver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the ChromeDriver run: `npx @puppeteer/browsers install chromedriver`

Copilot uses AI. Check for mistakes.
Comment on lines +172 to +179
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent capitalization. "Chrome Driver" should be "ChromeDriver" to match the standard naming convention used elsewhere in the documentation and in the environment variable name CHROMEDRIVER_BIN.

Suggested change
### Chrome Driver Configuration
Some tests require the Chrome Driver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the Chrome Driver run: `npx @puppeteer/browsers install chromedriver`
### ChromeDriver Configuration
Some tests require the ChromeDriver binary be installed with a matching Chrome version. This can be achieved with the
`@puppeteer/browsers` command from the npm registry.
To get the Chrome For Testing binary run: `npx @puppeteer/browsers install chrome`;
To get the ChromeDriver run: `npx @puppeteer/browsers install chromedriver`

Copilot uses AI. Check for mistakes.

> [!NOTE]
> Do check the commands arguments, you can set a path to install to so they
Copy link

Copilot AI Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical issue. "command's arguments" should be "command's arguments" or better yet "the command's arguments" for clarity.

Suggested change
> Do check the commands arguments, you can set a path to install to so they
> Do check the command's arguments, you can set a path to install to so they

Copilot uses AI. Check for mistakes.
> are more universally available.

Each command will first output the binary name installed, followed by the
full path to the binary installed. Copy that path to set to the environment
variables.

```shell
export CHROME_BIN=/path/to/Chrome
export CHROMEDRIVER_BIN=/path/to/ChromeDriver
```

If you don't set `CHROMEDRIVER_BIN` when required, an error will be thrown
instructing that it needs to be set and testing will not continue.

### Running and debugging specific unit tests

If you want to run a specific set of unit tests instead of all the unit tests, you can use one of the following commands:
Expand Down
Loading