Skip to content

Commit

Permalink
docs: branch review GA updates (#5505)
Browse files Browse the repository at this point in the history
* remove beta callouts

* add overview page

* tweak desc

* Apply suggestions from code review

Co-authored-by: Tyler Biethman <[email protected]>

* copy edit

* streamline copy

* reword missing run callout, tie to best practices

* remove test images

* update overview screenshot

---------

Co-authored-by: Tyler Biethman <[email protected]>
  • Loading branch information
jaffrepaul and tbiethman authored Sep 28, 2023
1 parent 0a918df commit 88ee02f
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 24 deletions.
53 changes: 29 additions & 24 deletions docs/guides/cloud/branch-review.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ sidebar_class_name: new_label

:::

:::info

&#8239;<Icon name="exclamation-triangle" /> Branch Review is currently in beta.
See [how to enable](/guides/cloud/branch-review#Public-Beta-Access) this feature below.

:::

## Overview

Cypress Branch Review is designed to elevate your pull request 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 and prevent the merging of low-quality code.
Expand All @@ -40,20 +33,6 @@ Cypress Branch Review is currently only available for [GitHub integrated project

:::

## Public Beta Access

:::tip

To access the Branch Review public beta, an admin can simply enable it under "Cypress Labs" in your Organization Settings in Cypress Cloud.

<DocsImage
src="/img/guides/cloud/branch-review/labs-beta.png"
alt="Enable Branch Review Beta"
width="90%"
/>

:::

## Getting Started

Branch Review works by leveraging the Cypress Cloud GitHub integration to query the GitHub API for branches with pull requests. Your project will first need to be connected to a GitHub repository. If you haven't already, follow the steps in [Install the Cypress GitHub app](/guides/cloud/integrations/source-control/github#Install-the-Cypress-GitHub-app) to connect your project to GitHub.
Expand Down Expand Up @@ -83,15 +62,29 @@ If the selected branch has a PR associated and a PR # passed via CI, there is an

### View Options

"Review" is the default view of the **Branches** tab for projects with linked GitHub repositories via our GitHub integration.
"Overview" is the default view of a branch for all projects.

:::note

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

"Runs" provides a list filtered by the selected branch for projects without linked repositories or those with an unknown branch. An unkown branch is one in which Cypress does not have access to the local `.git` directory and cannot determine a branch for a run.
2. Click "Review changes" for the full Branch Review.

3. Click any test status to reveal those changes.

4. Latest runs of the current branch for contextual guidance on the state of its test runs.

:::

<DocsImage
src="/img/guides/cloud/branch-review/branch-review-views.jpg"
src="/img/guides/cloud/branch-review/branch-review-views.png"
alt="Displaying different views for branches"
/>

"Review" provides the detailed Branch Review insights for the branch's available pull requests, with the latest pull request selected by default.

"Runs" provides a list of all runs that are attributed to the current branch.

### Review Header

The header includes the Git commit message, PR selector, PR status, and base and feature branch labels with the Cypress Cloud test run ID number (#).
Expand All @@ -109,6 +102,18 @@ Clicking the branch label will link you directly to the appropriate [run overvie

When on the review screen, you will see the Failures, Flaky, Pending, Added, and Modified tabs. Each tab will show you the specs that fall into that category. You can click on a test to view the test details.

:::info

If a run is missing on either the merge base or feature commit of the PR, a banner is displayed specifying which commit is missing the run with a link to it on GitHub.

:::

:::info

Recording exactly one run for every commit as the best/only way to ensure complete and accurate comparisons. See our [best practices](/guides/cloud/branch-review#Best-Practices) on grouping multiple `cypress run` calls under one run.

:::

<DocsImage
src="/img/guides/cloud/branch-review/branch-review-details.jpg"
alt="Branch Review Details"
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.

0 comments on commit 88ee02f

Please sign in to comment.