Document e2e test command options. #21962
Conversation
package.json
Outdated
| @@ -223,6 +223,8 @@ | |||
| "test": "npm run lint && npm run test-unit", | |||
| "test-e2e": "wp-scripts test-e2e --config packages/e2e-tests/jest.config.js", | |||
| "test-e2e:debug": "wp-scripts --inspect-brk test-e2e --config packages/e2e-tests/jest.config.js --puppeteer-devtools", | |||
| "test-e2e:open-browser": "cross-env PUPPETEER_HEADLESS=false PUPPETEER_SLOWMO=80 wp-scripts test-e2e --config packages/e2e-tests/jest.config.js", | |||
There was a problem hiding this comment.
With updates added to the documentation, do you think it's still valuable to have this script included here? It's not that much to type npm run test-e2e:watch -- --puppeteer-interactive.
There was a problem hiding this comment.
I agree. I don't think we need them any more. I didn't know that the options existed.
There was a problem hiding this comment.
I don't know why it wasn't documented :(
There was a problem hiding this comment.
It's how things work in software development. Computer wants everything but we sometimes miss one or two. That's why we work together to find those missing pieces.
Thanks for the great reivew.
1a80810 to
b78ee5b
Compare
|
Changed the title of this PR to |
| ``` | ||
|
|
||
| If you're using a different setup, you can provide the base URL, username and password like this: | ||
|
|
||
| ```bash | ||
| WP_BASE_URL=http://localhost:8888 WP_USERNAME=admin WP_PASSWORD=password npm run test-e2e | ||
| npm run test-e2e -- --wordpress-base-url=http://localhost:8888 --wordpress-username=admin --wordpress-password=password |
There was a problem hiding this comment.
I completely forgot about that, thank you for bringing it up as well :)
There was a problem hiding this comment.
So it was added in #14717 but it didn't touch this file.
Description
Document e2e test command options to make it work correctly on all platforms.
How has this been tested?
Manually tested.
Screenshots
N/A
Types of changes
New feature for developers.
Checklist: