You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/accessibility/changelog.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ sidebar_position: 200
24
24
25
25
## Week of 2/24/2025
26
26
27
-
-[Cypress Accessibility Branch Review](/accessibility/core-concepts/compare-reports) has entered beta. Read the docs to learn how to compare runs and automatically spot newly introduced issues.
27
+
-[Cypress Accessibility Branch Review](/accessibility/core-concepts/comparing-reports) has entered beta. Read the docs to learn how to compare runs and automatically spot newly introduced issues.
Copy file name to clipboardExpand all lines: docs/accessibility/core-concepts/comparing-reports.mdx
+43-6
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Comparing the results from different runs is useful in multiple scenarios.
29
29
-**Detecting content issues**: Sometimes content editors can introduce accessibility issues unrelated to code changes. Seeing the example issues presented visually, in context, helps you quickly triage whether you are dealing with a recent code change issue, or a content authorship problem.
30
30
-**Reviewing AI-generated code changes**: The increased use of AI to generate and/or review front-end code creates some increased risks of accessibility regressions making it to production. The increase or decrease of accessibility issues when reviewing a pull request helps you understand the impact of the change.
31
31
-**Tracing the introduction of issues**: With dropdowns for each run, it's easy to rapidly compare different A and B runs to find the exact commit that introduced a problem.
32
-
-**Demonstrating the resolution of issues**: Confirm the effect of your improvements, and share the overview with your team to more quickly review code changes.
32
+
-**Demonstrating the resolution of issues**: Confirm the effect of your improvements, and share overview with your team to more quickly review code changes.
33
33
34
34
## Content of the report
35
35
@@ -49,8 +49,47 @@ This organization of the report brings the most significant results to the top -
49
49
50
50
## How to compare runs
51
51
52
-
The first step is to get to the [Branch Review](/cloud/features/branch-review.mdx) area of Cypress Cloud, which will let you compare one branch against another - or different runs on the same branch, if needed.
53
-
You can access this area by clicking the branch name associated with a run, or in several other ways. [Learn more about how to compare runs](/cloud/features/branch-review.mdx).
52
+
The first step is to get to the Branch Review area of Cypress Cloud, which will let you compare one branch against another - or different runs on the same branch, if needed. We refer to be baseline fun for comparison as the `base` run, and the changes we are comparing with as the `changed` run.
53
+
54
+
There are a number of ways to get to Branch Review depending on where you are looking at your Cypress results. In all cases, once you've picked a `changed` run, you can adjust the automatically-selected `base` run to any branch or run in the project.
alt="A pull request comment from Cypress with an arrow pointing to the 'View all changes introduced in this branch' link. Test results and some accessibility score and violation information is also visible in the comment. The project has an 86.86% accessibility score, with 9 failed elements. Failed rule counts are 1 critical, 1 serious, 3 moderate, and 0 minor."
61
+
/>
62
+
63
+
Click the "View all changes introduced in this branch" link at the bottom of the Test Results table. You will enter branch review with the current PR's branch and latest run pre-selected as the "changed" run.
64
+
65
+
### From the run list
66
+
67
+
Click the branch name associated with the run. This will take you to Branch Review with that branch's newest run pre-selected as the `changed` run.
alt="A card showing the name of an example project and related branches to choose."
80
+
/>
81
+
82
+
The project card shows three active branches for the project. You can click through to any of these to enter Branch Review with the newest run on that branch pre-selected as the `changed` run.
alt="The main Cypress Cloud navigation showing Latest Runs, Branches, and Analytics menu items. An arrow points to Branches."
90
+
/>
91
+
92
+
When inside of a project, you can select "Branches" in the main navigation to see a full, filterable list of available branches and choose one to set as the `changed` run.
54
93
55
94
## FAQ
56
95
@@ -60,11 +99,9 @@ The best subjects to compare are passing runs that ran similar tests on the same
60
99
61
100
That said, it still possible and valid to compare runs from different points in time with different sets of test results, as long as you bear in mind all the potential sources of difference between the two runs, which you can evaluate for yourself as you explore the results.
62
101
63
-
In order to see unified changes for your entire test suite, you need to group all the tests together under a single Cypress run, for each report. Learn more about this in the [Branch Review Best Practices documentation](/cloud/features/branch-review#Best-Practices).
64
-
65
102
### What is the purpose of the Beta label?
66
103
67
-
This indicates the feature is ready for use and actively seeking feedback based on real usage of the current implementation. We have a few known issues to work through on our side before we consider this fully production-ready and remove the beta label. These issues only affect a subset of projects -- in most cases everything is working as intended. If you see anything unexpected, please use the feedback button and let us know.
104
+
This indicates the feature is ready for use and actively seeking feedback based on real usage of the current implementation. We have a few known issues to work through on our side before we consider this fully production-ready and remove the beta label. These issues only affect a subset of projects -- in most cases everything is working as intended. If you see anything unexpected, please hit the feedback button and let us know.
68
105
69
106
### Why do I see some views (pages or components) changing from run-to-run?
Copy file name to clipboardExpand all lines: docs/accessibility/core-concepts/how-it-works.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Cypress Accessibility seamlessly integrates accessibility testing into your deve
15
15
1.**Processing**: When your run completes, the final specs are processed for accessibility checks. Earlier specs have already entered processing and are likely completed by the end of the run.
16
16
1.**Organizing Views**: Cypress Cloud groups Views (pages and components) rendered during the run, merging and deduplicating across tests. This ensures page-level results and live DOM snapshots are organized effectively.
17
17
1.**Generating reports**: A combined "rule-level" report is created, summarizing all detected accessibility violations.
18
-
1.**Displaying results**: Results are displayed in Cypress Cloud in the run details area as well as in [Branch Review](/accessibility/core-concepts/compare-reports) for comparing runs. Accessibility is also flagged in integrations (e.g., Slack, GitHub/GitLab comments), and accessible via the [Results API](/accessibility/results-api) for optional CI pipeline actions (e.g., failing builds based on unmet standards).
18
+
1.**Displaying results**: Results are displayed in Cypress Cloud in the run details area as well as in [Branch Review](/accessibility/core-concepts/comparing-reports) for comparing runs. Accessibility is also flagged in integrations (e.g., Slack, GitHub/GitLab comments), and accessible via the [Results API](/accessibility/results-api) for optional CI pipeline actions (e.g., failing builds based on unmet standards).
Copy file name to clipboardExpand all lines: docs/accessibility/guides/detect-changes.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ sidebar_position: 70
11
11
12
12
Cypress Accessibility supports three main paths to observing and acting on changes in the accessibility report for your projects:
13
13
14
-
- Run comparisons with [Branch Review](/accessibility/core-concepts/compare-reports)
14
+
- Run comparisons with [Branch Review](/accessibility/core-concepts/comparing-reports)
15
15
- The [Results API](/accessibility/results-api) to fail builds or trigger alerts when results don't meet your standards
16
16
-[Analytics](/cloud/features/analytics/enterprise-reporting#Cypress-Accessibility) for high-level trend-spotting and analysis
17
17
@@ -33,7 +33,7 @@ Use Branch review when reviewing a pull request made by another developer or bef
33
33
34
34
Since this reduces the amount of violations to review to just what was affected by the PR code changes, you won't spend any time looking for what's relevant -- and if there is no difference, you'll know your PR does not affect the accessibility score and is safe to merge.
35
35
36
-
See the main [Accessibility Branch Review docs](/accessibility/core-concepts/compare-reports) for a video demo of this workflow.
36
+
See the main [Accessibility Branch Review docs](/accessibility/core-concepts/comparing-reports) for a video demo of this workflow.
37
37
38
38
#### Compare reports during local development (without waiting for CI)
0 commit comments