docs: clarify behavior of each trace and video mode#41127
Merged
Conversation
Add a comparison table and a scenario table to the recording options guide, and tighten the per-mode descriptions so the difference between retain-on-failure and the other modes is unambiguous.
Mirror the trace mode clarification for the video option: tighten the per-mode descriptions and add comparison and scenario tables to the recording options guide.
yury-s
changed the title
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Member
Author
|
Rendered section: Trace modesThe
The following table shows which traces are kept in a few common scenarios, assuming
:::note |
dgozman
approved these changes
Jun 3, 2026
| | `'on-first-retry'` | — | first retry | first retry | | ||
| | `'on-all-retries'` | — | first retry | both retries | | ||
|
|
||
| :::note |
Collaborator
There was a problem hiding this comment.
I am not sure this note helps at all. Same for the video note.
| | [`property: TestOptions.trace`] | Playwright can produce test traces while running the tests. Later on, you can view the trace and get detailed information about Playwright execution by opening [Trace Viewer](./trace-viewer.md). Options include: `'off'`, `'on'`, `'retain-on-failure'` and `'on-first-retry'` | | ||
| | [`property: TestOptions.video`] | Playwright can record [videos](./videos.md) for your tests. Options include: `'off'`, `'on'`, `'retain-on-failure'` and `'on-first-retry'` | | ||
|
|
||
| #### Trace modes |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Contributor
Test results for "MCP"7230 passed, 1103 skipped Merge workflow run. |
Contributor
Test results for "tests 1"1 failed 5 flaky39527 passed, 771 skipped Merge workflow run. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
traceandvideomode records and keeps, so the difference betweenretain-on-failureand the other modes is unambiguous (follow-up to removingretain-all-failuresin chore(trace): remove retain-all-failures trace and video mode #41123).retain-on-failurealready keeps a failed run's trace/video even when a later retry passes.