diff --git a/docs/guides/cloud/branch-review.mdx b/docs/guides/cloud/branch-review.mdx index 48490e65139..ef4873095da 100644 --- a/docs/guides/cloud/branch-review.mdx +++ b/docs/guides/cloud/branch-review.mdx @@ -3,10 +3,12 @@ title: Branch Review sidebar_position: 35 --- -Cypress Branch Review allows you to quickly identify the impact a pull request might have on your test suite in a single view. Compare which tests are failing, flaky, pending, added, or modified between the source and base branches. +Cypress Branch Review is designed to elevate your pull request (PR) review workflow. It allows you to quickly identify the impact a pull request might have on your test suite in a single view. Compare which tests are failing, flaky, pending, added, or modified between the **source** and **base** branches. + +Previously, pinpointing changes in your test suite's results required a manual side-by-side comparison between your newly-introduced branch's test runs and your base branch's test runs. This sub-optimal workflow often fails to answer the fundamental questions, _what changed_ and _why?_ You might be left wondering if the same tests are flaky between branches, when new failures were introduced, or if you added sufficient test coverage to your new branch. @@ -42,9 +44,11 @@ Branch Review is the default view of the **Branches** tab. You can also toggle t ### Review Header -At the left side of the header is the Git commit message, PR selector, PR status and base and target branch indicators. If there are multiple pull requests open for the same branch, you can select the pull request you want to review from the dropdown to the right of the commit message. +The header includes the Git commit message, PR selector, PR status and base and target branch indicators with the Cypress Cloud test run ID number (#). + +If there are multiple pull requests open for the same branch, you can select the pull request you want to review from the dropdown to the right of the commit message. -The right side of the header includes the Cypress Cloud test run number and test summary. Clicking the test run number will link you directly to the [test overview](/guides/cloud/recorded-runs#Overview-tab). +Clicking the branch indicators will link you directly to the appropriate [test overview](/guides/cloud/recorded-runs#Overview-tab) and hovering on these elements exposes additional test meta data. :::info -The arrows next to the numbers in each of the tabs indicate: +The status key in each of the tabs indicates: - - total number increased in your branch -- - total number decreased in your branch + + total number increased in your branch - - there are new items, but the total count remained the same - for example, - 1 resolved and 1 added - + + + total number decreased in your branch +-   + + + +there are new items, but the total count remained the same - for example, 1 resolved and 1 added ::: ### Review Test Comparison -Navigating into the test detail view reveals a side-by-side comparison of the test in each branch which can help 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. +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 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. diff --git a/static/img/guides/cloud/branch-review/arrow_up.jpg b/static/img/guides/cloud/branch-review/arrow_up.jpg new file mode 100644 index 00000000000..ef1f7057913 Binary files /dev/null and b/static/img/guides/cloud/branch-review/arrow_up.jpg differ diff --git a/static/img/guides/cloud/branch-review/branch-review-details2.jpg b/static/img/guides/cloud/branch-review/branch-review-details2.jpg new file mode 100644 index 00000000000..9326933085e Binary files /dev/null and b/static/img/guides/cloud/branch-review/branch-review-details2.jpg differ diff --git a/static/img/guides/cloud/branch-review/branch-review-header.jpg b/static/img/guides/cloud/branch-review/branch-review-header.jpg index c7e68f910e9..ff73635a468 100644 Binary files a/static/img/guides/cloud/branch-review/branch-review-header.jpg and b/static/img/guides/cloud/branch-review/branch-review-header.jpg differ diff --git a/static/img/guides/cloud/branch-review/branch-review2.jpg b/static/img/guides/cloud/branch-review/branch-review2.jpg new file mode 100644 index 00000000000..09efd4940dd Binary files /dev/null and b/static/img/guides/cloud/branch-review/branch-review2.jpg differ diff --git a/static/img/guides/cloud/branch-review/branch-review3.jpg b/static/img/guides/cloud/branch-review/branch-review3.jpg new file mode 100644 index 00000000000..6ef23bf26c4 Binary files /dev/null and b/static/img/guides/cloud/branch-review/branch-review3.jpg differ diff --git a/static/img/guides/cloud/branch-review/pull-request-dropdown.jpg b/static/img/guides/cloud/branch-review/pull-request-dropdown.jpg deleted file mode 100644 index 5090861138e..00000000000 Binary files a/static/img/guides/cloud/branch-review/pull-request-dropdown.jpg and /dev/null differ diff --git a/static/img/guides/cloud/branch-review/test-comparison2.jpg b/static/img/guides/cloud/branch-review/test-comparison2.jpg new file mode 100644 index 00000000000..413a011bdb8 Binary files /dev/null and b/static/img/guides/cloud/branch-review/test-comparison2.jpg differ