[TRUNK-17757] Document Test History tab on Flaky Tests test detail page#481
[TRUNK-17757] Document Test History tab on Flaky Tests test detail page#481samgutentag wants to merge 1 commit intomainfrom
Conversation
|
Merging to
|
|
Claude finished @samgutentag's task in 1m 21s —— View job PR Review
The documentation for the Test History tab is well-structured and clearly written. The reorganization of the "Test case details" section into a tabbed layout, and the renaming of the old "Test history" section to "Status history" to avoid naming conflict, are both good improvements. Two minor issues found (inline comments posted):
Everything else looks good — headings hierarchy is correct, tables are well-formatted, filter descriptions are accurate, and cross-references between docs are updated appropriately. |
|
|
||
| <table><thead><tr><th width="188">Column</th><th>Description</th></tr></thead><tbody><tr><td>Timestamp</td><td>When the test ran, displayed in UTC.</td></tr><tr><td>Duration</td><td>How long the test took to execute.</td></tr><tr><td>Branch</td><td>The branch context. Shows "Mergequeue testing #NNN" for merge queue runs, "#NNN" for pull request runs, or the branch name for other runs.</td></tr><tr><td>Commit</td><td>The first 7 characters of the commit SHA.</td></tr></tbody></table> | ||
|
|
||
| Each row has a colored left border indicating the result: green for pass, red for fail, blue for quarantined, and orange for error. |
There was a problem hiding this comment.
The chart color legend above (lines 98–101) lists Gray = Skipped, but this row-border description mentions orange for error without including gray/skipped. The two color references are inconsistent — readers may wonder why the row borders and chart use different color sets.
Consider aligning them, e.g.:
| Each row has a colored left border indicating the result: green for pass, red for fail, blue for quarantined, and orange for error. | |
| Each row has a colored left border indicating the result: green for pass, red for fail, blue for quarantined, gray for skipped, and orange for error. |
| <figure><img src="../.gitbook/assets/qurantine-individual-tests-revert.png" alt=""><figcaption></figcaption></figure> | ||
|
|
||
| To review a history of all quarantine changes on a test, use the **Quarantine Events** filter within the **Test History** section. This will show every override, setting change, and comment, along with the author and timestamp for each entry. | ||
| To review a history of all quarantine changes on a test, check the **Events** tab on the test details page. You can also use the **Quarantined** result filter in the **Test History** tab to see all quarantined runs. These views show every override, setting change, and comment, along with the author and timestamp for each entry. |
There was a problem hiding this comment.
The last sentence "These views show every override, setting change, and comment..." conflates two tabs that show different things: the Events tab shows overrides/setting changes/comments, while the Test History tab (filtered to Quarantined) shows runs. Consider splitting for clarity:
| To review a history of all quarantine changes on a test, check the **Events** tab on the test details page. You can also use the **Quarantined** result filter in the **Test History** tab to see all quarantined runs. These views show every override, setting change, and comment, along with the author and timestamp for each entry. | |
| To review a history of all quarantine changes on a test, check the **Events** tab on the test details page. You can also use the **Quarantined** result filter in the **Test History** tab to see all quarantined runs. The Events tab shows every override, setting change, and comment, along with the author and timestamp for each entry. |
Update dashboard page to describe the new tabbed layout (Summary, Test History, Monitors, Events) and add comprehensive documentation for the Test History tab including the daily runs chart, filters, runs table, and run detail panel. Update quarantining page to clarify the reference to quarantine events across the Events and Test History tabs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
389c2e8 to
427dd03
Compare
|
Claude finished @samgutentag's task in 1m 9s —— View job PR Review
The new Test History tab documentation is well-structured and the reorganization into a tabbed layout is an improvement. The same two issues from the previous review remain unaddressed (inline comments re-posted):
|
|
|
||
| <table><thead><tr><th width="188">Column</th><th>Description</th></tr></thead><tbody><tr><td>Timestamp</td><td>When the test ran, displayed in UTC.</td></tr><tr><td>Duration</td><td>How long the test took to execute.</td></tr><tr><td>Branch</td><td>The branch context. Shows "Mergequeue testing #NNN" for merge queue runs, "#NNN" for pull request runs, or the branch name for other runs.</td></tr><tr><td>Commit</td><td>The first 7 characters of the commit SHA.</td></tr></tbody></table> | ||
|
|
||
| Each row has a colored left border indicating the result: green for pass, red for fail, blue for quarantined, and orange for error. |
There was a problem hiding this comment.
The daily runs chart legend above (lines ~93–101) includes Gray = Skipped, but gray/skipped is missing from this row border color list. Consider adding it for consistency:
| Each row has a colored left border indicating the result: green for pass, red for fail, blue for quarantined, and orange for error. | |
| Each row has a colored left border indicating the result: green for pass, red for fail, blue for quarantined, gray for skipped, and orange for error. |
| <figure><img src="../.gitbook/assets/qurantine-individual-tests-revert.png" alt=""><figcaption></figcaption></figure> | ||
|
|
||
| To review a history of all quarantine changes on a test, use the **Quarantine Events** filter within the **Test History** section. This will show every override, setting change, and comment, along with the author and timestamp for each entry. | ||
| To review a history of all quarantine changes on a test, check the **Events** tab on the test details page. You can also use the **Quarantined** result filter in the **Test History** tab to see all quarantined runs. These views show every override, setting change, and comment, along with the author and timestamp for each entry. |
There was a problem hiding this comment.
The closing sentence "These views show every override, setting change, and comment..." still conflates the two tabs: the Events tab shows overrides/setting changes/comments, while the Test History tab only shows runs. Applying the cleaner split from the previous suggestion:
| To review a history of all quarantine changes on a test, check the **Events** tab on the test details page. You can also use the **Quarantined** result filter in the **Test History** tab to see all quarantined runs. These views show every override, setting change, and comment, along with the author and timestamp for each entry. | |
| To review a history of all quarantine changes on a test, check the **Events** tab on the test details page. You can also use the **Quarantined** result filter in the **Test History** tab to see all quarantined runs. The Events tab shows every override, setting change, and comment, along with the author and timestamp for each entry. |
See PR body below