Skip to content

Commit

Permalink
add better screenshots (#5507)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaffrepaul authored Sep 28, 2023
1 parent eb84caa commit 1459cce
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/guides/cloud/branch-review.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If you do not see PR # tags associated with a branch, you may need to [pass PR n
If the selected branch has a PR associated and a PR # passed via CI, there is an additional callout on the top of the overview tab of the **Latest runs** page which directs to the Branch Review.

<DocsImage
src="/img/guides/cloud/branch-review/branch-review-available.jpg"
src="/img/guides/cloud/branch-review/branch-review-available.png"
alt="Branch Review available banner"
/>

Expand All @@ -71,6 +71,8 @@ If the selected branch has a PR associated and a PR # passed via CI, there is an

:::note

**Branch Overview**

1. Callouts for the latest available Branch Review or a reminder to create a pull request in order to compare test run results.

2. Click "Review changes" for the full Branch Review.
Expand Down Expand Up @@ -121,6 +123,8 @@ Recording exactly one run for every commit as the best/only way to ensure comple

:::note

**Review Test Status**

1. Review your PR information
2. Get a glance of changes in your branch across key statuses
3. See what has changed in a specific status, for example:
Expand Down Expand Up @@ -148,10 +152,26 @@ Recording exactly one run for every commit as the best/only way to ensure comple
Navigating into the test detail view reveals a side-by-side comparison of the test results on both branches, as well as, artifacts so you can compare before vs. after your PR. This can help narrow the focus on changes introduced or resolved on either branch and elevate the source of flake within tests throughout different attempts. Review the test definition panel for diff snapshots to help quickly determine changes in test code.

<DocsImage
src="/img/guides/cloud/branch-review/test-comparison.jpg"
src="/img/guides/cloud/branch-review/test-comparison.png"
alt="Test Comparison View"
/>

:::note

**Review Test Comparison**

1. Base branch results

2. Feature branch results

3. Test Replay and artifacts

4. Test attempts (decending order)

5. Code change diffs

:::

## GitHub Pull Request Comments

The Cypress Cloud GitHub Integration offers detailed test information via [PR comments](/guides/cloud/integrations/source-control/github#Pull-request-comments). Follow the "Review all test suite changes" link to load the Branch Review between the feature and base branches.
Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1459cce

Please sign in to comment.