Skip to content

[docs] Reduce redundancy in playwright.md reference doc #26360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Apr 15, 2026
Merged

[docs] Reduce redundancy in playwright.md reference doc #26360

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 3 additions & 36 deletions docs/src/content/docs/reference/playwright.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,11 @@ sidebar:

Configure Playwright for browser automation and testing in your agentic workflows. Playwright enables headless browser control for accessibility testing, visual regression detection, end-to-end testing, and web scraping.

```yaml wrap
tools:
playwright:
playwright:
version: "1.56.1" # Optional: specify version, defaults to 1.56.1
playwright:
version: "latest" # Use the latest available version
```

## Configuration Options

### Version

Specify the Playwright version to use:
Pin to a specific version or use the latest:

```yaml wrap
tools:
Comment on lines +14 to 17
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

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

The wording here implies the default is a pinned version. In practice the default behavior is “omit version”, and the documented default 1.56.1 should match the implementation default (DefaultPlaywrightBrowserVersion is v1.59.1 in pkg/constants/version_constants.go). Please adjust the text/example so it shows the true default case and aligns the default version value with the code.

Copilot uses AI. Check for mistakes.
Expand Down Expand Up @@ -62,37 +53,13 @@ network:

**Automatic subdomain matching**: When you allow `example.com`, all subdomains like `api.example.com`, `www.example.com`, and `staging.example.com` are automatically allowed.

### Default Localhost Access

Without any `network:` configuration, Playwright defaults to:

```yaml wrap
network:
allowed:
- "localhost"
- "127.0.0.1"
```

This is sufficient for testing local development servers.

## GitHub Actions Compatibility

Playwright runs in a Docker container on GitHub Actions runners. To ensure Chromium functions correctly, gh-aw automatically configures required security flags:

- `--security-opt seccomp=unconfined` - Allows Chromium's sandboxing mechanisms
- `--ipc=host` - Enables inter-process communication for browser processes

These flags are automatically applied starting with **gh-aw version 0.41.0 and later**. No manual configuration is needed.
Playwright runs in a Docker container on GitHub Actions runners. gh-aw automatically applies `--security-opt seccomp=unconfined` and `--ipc=host` (required for Chromium) starting with version 0.41.0. No manual configuration is needed.

## Browser Support

Playwright includes three browser engines:

- **Chromium** - Chrome/Edge engine (most commonly used)
- **Firefox** - Mozilla Firefox engine
- **WebKit** - Safari engine

All three browsers are available in the Playwright Docker container. Your workflow can use any or all of them based on your testing needs.
Playwright includes three browser engines: **Chromium** (Chrome/Edge, most commonly used), **Firefox**, and **WebKit** (Safari). All three are available in the Playwright Docker container.

## Common Use Cases

Expand Down
Loading