Skip to content

Docs: Remove Puppeteer references and update to Playwright#76766

Merged
youknowriad merged 2 commits intoWordPress:trunkfrom
meravi:docs/remove-puppeteer-references
Mar 25, 2026
Merged

Docs: Remove Puppeteer references and update to Playwright#76766
youknowriad merged 2 commits intoWordPress:trunkfrom
meravi:docs/remove-puppeteer-references

Conversation

@meravi
Copy link
Copy Markdown
Contributor

@meravi meravi commented Mar 23, 2026

What?

Updates documentation to remove outdated Puppeteer references,
replacing them with Playwright.

Why?

The project has fully migrated from Puppeteer to Playwright for
end-to-end testing. The documentation still contained outdated
references to Puppeteer.

How?

  • Rewrote automated-testing.md to explain why Playwright is the
    tool of choice (kept the architecture page per feedback from
    @youknowriad in Documentation: Remove Puppeteer references #60416)
  • Updated the E2E section in testing-overview.md to remove
    Puppeteer-specific commands
  • Updated link text in README.md files
  • Cleaned up legacy Puppeteer mention in e2e/README.md

Testing Instructions

  1. Verify all internal documentation links work correctly
  2. Review that no Puppeteer references remain in the changed files

Fixes #60416

Updates the block editor documentation to remove outdated Puppeteer
references. The project has fully migrated to Playwright for
end-to-end testing.

- Rewrites automated-testing.md to explain why Playwright is the
  tool of choice
- Removes Puppeteer-specific CLI flags from testing-overview.md
- Updates README link text in explanations docs
- Cleans up legacy Puppeteer mention in e2e guide
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 23, 2026

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Required label: Any label starting with [Type].
  • Labels found: First-time Contributor.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

@github-actions
Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: meravi <[email protected]>
Co-authored-by: youknowriad <[email protected]>
Co-authored-by: himanshupathak95 <[email protected]>
Co-authored-by: Mamaduka <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Mar 23, 2026
@github-actions
Copy link
Copy Markdown

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @meravi! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

Copy link
Copy Markdown
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

This looks good.

### Avoid global variables

Previously in our Jest + Puppeteer E2E tests, `page` and `browser` are exposed as global variables. This makes it harder to work with when we have multiple pages/tabs in the same test, or if we want to run multiple tests in parallel. `@playwright/test` has the concept of [fixtures](https://playwright.dev/docs/test-fixtures) which allows us to inject `page`, `browser`, and other parameters into the tests.
In the previous E2E test setup, `page` and `browser` were exposed as global variables. This made it harder to work with when having multiple pages/tabs in the same test, or when running multiple tests in parallel. `@playwright/test` has the concept of [fixtures](https://playwright.dev/docs/test-fixtures) which allows us to inject `page`, `browser`, and other parameters into the tests.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not entirely convinced the change here is necessary

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Simplified this and removed the duplication
Could you please take another look? @youknowriad


```bash
WP_BASE_URL=http://wp.test npm run test:e2e -- --wordpress-username=admin --wordpress-password=password
npm run test:e2e -- --ui
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this the right command? I've always used --headed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yep, both are valid 🙂 --headed just runs the browser visibly, while --ui gives you the Playwright UI, which is handy for debugging, so that’s why it’s in the docs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, debug UI is more helpful.

@youknowriad youknowriad requested a review from Mamaduka March 24, 2026 08:10
Copy link
Copy Markdown
Member

@Mamaduka Mamaduka left a comment

Choose a reason for hiding this comment

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

This looks good. Thanks, @meravi!

@youknowriad youknowriad merged commit fe5d9ce into WordPress:trunk Mar 25, 2026
41 of 43 checks passed
@github-actions github-actions bot added this to the Gutenberg 22.9 milestone Mar 25, 2026
adamsilverstein pushed a commit that referenced this pull request Mar 26, 2026
Co-authored-by: meravi <[email protected]>
Co-authored-by: youknowriad <[email protected]>
Co-authored-by: himanshupathak95 <[email protected]>
Co-authored-by: Mamaduka <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Remove Puppeteer references

3 participants