Skip to content

Commit 4273c72

Browse files
authored
Merge branch 'main' into adding-descope-testing-strat-guide
2 parents 7e0fb62 + e90a257 commit 4273c72

File tree

19 files changed

+76
-41
lines changed

19 files changed

+76
-41
lines changed

docs/accessibility/changelog.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ sidebar_position: 200
1717

1818
## Week of 9/30/2024
1919

20-
- Cypress Accessibility results are now included in Slack messages alongside test results. [Learn more about our Slack integration here](https://on.cypress.io/slack-integration).
20+
- Cypress Accessibility results are now included in Slack messages alongside test results. [Learn more about our Slack integration here](/cloud/integrations/slack).
2121

2222
## Week of 9/20/2024
2323

@@ -34,7 +34,7 @@ sidebar_position: 200
3434
## Week of 8/19/2024
3535

3636
- iFrames are now supported for accessibility checks. iFrame processing is _opt-in_ for existing customers, but new customers will begin with iFrames enabled and can choose to opt out instead. This is to avoid disrupting existing pipelines, especially because iFrame content is not _always_ something you want to include in your reports.
37-
- Cypress Accessibility results will now appear in [GitHub](https://on.cypress.io/github-integration), [GitLab](https://on.cypress.io/gitlab-integration) and [Bitbucket](https://on.cypress.io/bitbucket-integration) pull request and merge request comments alongside test results. Integrations can be installed and comments can be enabled in Project Settings.
37+
- Cypress Accessibility results will now appear in [GitHub](/cloud/integrations/source-control/github), [GitLab](/cloud/integrations/source-control/gitlab) and [Bitbucket](/cloud/integrations/source-control/bitbucket) pull request and merge request comments alongside test results. Integrations can be installed and comments can be enabled in Project Settings.
3838

3939
## Week of 8/5/2024
4040

docs/accessibility/core-concepts/how-it-works.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ In rare cases - such as if an Axe Core® update contains a critical security pat
4343

4444
## Powered by Test Replay
4545

46-
Because Cypress Accessibility uses data captured through Cypress Test Replay, it is subject [Test Replay limitations](https://docs.cypress.io/faq/questions/cloud-faq#Is-everything-captured-and-replayed-in-Test-Replay).
46+
Because Cypress Accessibility uses data captured through Cypress Test Replay, it is subject to Test Replay limitations. Read [How Test Replay Works](/cloud/features/test-replay#How-Test-Replay-Works) to discover which data is captured and which browsers are supported.

docs/api/commands/get.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,9 @@ cy.get('form').within(() => {
146146
### Get vs Find
147147

148148
The `cy.get` command always starts its search from the
149-
[cy.root](https://on.cypress.io/root) element. In most cases, it is the
149+
[cy.root](/api/commands/root) element. In most cases, it is the
150150
`document` element, unless used inside the [.within()](/api/commands/within)
151-
command. The [.find](https://on.cypress.io/find) command starts its search from
151+
command. The [.find](/api/commands/find) command starts its search from
152152
the current subject.
153153

154154
```html

docs/app/continuous-integration/github-actions.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ In the GitHub Actions configuration, we have defined in the previous section, we
431431
are leveraging three useful features of
432432
[Cypress Cloud](/cloud/get-started/introduction):
433433

434-
1. [Recording test results with the `record: true` option](https://on.cypress.io/how-do-i-record-runs)
434+
1. [Recording test results with the `record: true` option](/cloud/get-started/setup)
435435
to [Cypress Cloud](https://on.cypress.io/cloud):
436436

437437
- In-depth and shareable
@@ -540,7 +540,7 @@ jobs:
540540
:::tip
541541

542542
We also recommend adding `COMMIT_INFO_SHA` to re-enable
543-
[Cypress bot PR comments](https://on.cypress.io/github#Pull-request-comments).
543+
[Cypress bot PR comments](/cloud/integrations/source-control/github#Pull-request-comments).
544544
See
545545
[this comment](https://github.com/cypress-io/github-action/issues/124#issuecomment-716584972)
546546
for more details.

docs/app/continuous-integration/overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ Cypress:**
352352
- The browser crashes.
353353

354354
You can see the total available machine memory and the current free memory by
355-
running the [`cypress info`](https://on.cypress.io/command-line#cypress-info)
355+
running the [`cypress info`](/app/references/command-line#cypress-info)
356356
command.
357357

358358
{/* hack: using css language label to respect decimals in syntax highlighting */}

docs/app/faq.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ application, it helps you write your tests.
9090
There is a plugin and detailed documentation on how to get end-to-end, unit and
9191
full stack code coverage.
9292

93-
- Read our [Code Coverage guide](https://on.cypress.io/code-coverage)
93+
- Read our [Code Coverage guide](/app/tooling/code-coverage)
9494
- Use the [@cypress/code-coverage](https://github.com/cypress-io/code-coverage)
9595
plugin
9696

docs/app/guides/migration/protractor-to-cypress.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ When it comes to e2e tests, one of the most common things you'll need to do is
311311
get one or more HTML elements on a page. Rather than split element fetching into
312312
multiple methods that you need to memorize, everything can be accomplished with
313313
[`cy.get`](/api/commands/get) while using CSS selectors or the preferred
314-
[**data attribute**](https://on.cypress.io/selecting-elements).
314+
[**data attribute**](/app/core-concepts/best-practices#Selecting-Elements).
315315

316316
<Badge type="danger">Before: Protractor</Badge>
317317

@@ -1217,7 +1217,7 @@ Read our docs to learn more about speeding up test execution in CI via
12171217
As you write more and more end-to-end tests, you will find yourself wondering -
12181218
do I need to write more tests? Are there parts of the application still
12191219
untested? Are there parts of the application that perhaps are tested too much?
1220-
This [code coverage guide](https://on.cypress.io/code-coverage) is an excellent
1220+
This [code coverage guide](/app/tooling/code-coverage) is an excellent
12211221
resource to learn how to add code coverage.
12221222

12231223
### Questions or Issues?

docs/app/references/changelog.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -1030,7 +1030,7 @@ _Released 04/26/2023_
10301030
- Added Component Testing support for Angular 16. Addresses
10311031
[#26044](https://github.com/cypress-io/cypress/issues/26044).
10321032
- The run navigation component on the
1033-
[Debug page](https://on.cypress.io/debug-page) will now display a warning
1033+
[Debug page](/app/core-concepts/open-mode#Debug) will now display a warning
10341034
message if there are more relevant runs than can be displayed in the list.
10351035
Addresses [#26288](https://github.com/cypress-io/cypress/issues/26288).
10361036

@@ -1040,7 +1040,7 @@ _Released 04/26/2023_
10401040
output to be broken. `0` is now treated as false. Addresses
10411041
[#5191](https://github.com/cypress-io/cypress/issues/5191) and
10421042
[#24595](https://github.com/cypress-io/cypress/issues/24595).
1043-
- Fixed an issue on the [Debug page](https://on.cypress.io/debug-page) where the
1043+
- Fixed an issue on the [Debug page](/app/core-concepts/open-mode#Debug) where the
10441044
passing run status would appear even if the Cypress Cloud organization was
10451045
over its monthly test result limit. Addresses
10461046
[#26528](https://github.com/cypress-io/cypress/issues/26528).
@@ -1064,7 +1064,7 @@ _Released 04/17/2023_
10641064

10651065
- The Component Testing setup wizard will now show a warning message if an issue
10661066
is encountered with an installed
1067-
[third party framework definition](https://on.cypress.io/component-integrations).
1067+
[third party framework definition](/app/component-testing/custom-frameworks).
10681068
Addresses [#25838](https://github.com/cypress-io/cypress/issues/25838).
10691069

10701070
**Bugfixes:**
@@ -1310,7 +1310,7 @@ _Released 02/15/2023_
13101310
Enterprise plans the flexibility to alter the auto-cancellation value per run.
13111311
Addressed in [#25237](https://github.com/cypress-io/cypress/pull/25237).
13121312
- It is now possible to overwrite query commands using
1313-
[`Cypress.Commands.overwriteQuery`](https://on.cypress.io/api/custom-queries).
1313+
[`Cypress.Commands.overwriteQuery`](/api/cypress-api/custom-queries).
13141314
Addressed in [#25078](https://github.com/cypress-io/cypress/issues/25078).
13151315
- Added [`Cypress.require()`](/api/cypress-api/require) for including
13161316
dependencies within the [`cy.origin()`](/api/commands/origin) callback. This
@@ -4486,9 +4486,9 @@ _Released 06/23/2021_
44864486
**Features:**
44874487

44884488
- You can now override the default delay between typing characters for `.type()`
4489-
with [`Cypress.Keyboard.defaults()`](https://on.cypress.io/keyboard-api) or
4489+
with [`Cypress.Keyboard.defaults()`](/api/cypress-api/keyboard-api) or
44904490
via
4491-
[test configuration](https://on.cypress.io/writing-and-organizing-tests#Allowed-config-values).
4491+
[test configuration](/app/core-concepts/writing-and-organizing-tests#Allowed-config-values).
44924492
Addresses [#566](https://github.com/cypress-io/cypress/issues/566).
44934493
- The experience when opening a new project via `cypress open` has been
44944494
improved. Addressed in

docs/app/references/configuration.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ syntax, which is the default for JavaScript files. All JavaScript config
4040
examples in our docs use the CommonJS format.
4141

4242
If you [configure your tests to record](/cloud/get-started/setup#Setup) the
43-
results to [Cypress Cloud](https://on.cypress.io/cloud-introduction) the
43+
results to [Cypress Cloud](/cloud/get-started/introduction) the
4444
`projectId` will be stored in the config file as well.
4545

4646
## Intelligent Code Completion

docs/app/references/error-messages.mdx

+5-6
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ it('does not forget to return a promise', () => {
451451
<strong>Note</strong>
452452

453453
This error only pertains to Cypress version `v11.0.0` and under. As of Cypress
454-
[v12.0.0](https://on.cypress.io/changelog#12-0-0), users can navigate to
454+
[v12.0.0](/app/references/changelog#12-0-0), users can navigate to
455455
multiple domains in a single test.
456456

457457
:::
@@ -465,7 +465,7 @@ See our [Cross Origin Testing](/app/guides/cross-origin-testing#Limitations) doc
465465
<strong>Note</strong>
466466

467467
This error only pertains to Cypress version `v11.0.0` and under. As of Cypress
468-
[v12.0.0](https://on.cypress.io/changelog#12-0-0), users can navigate to
468+
[v12.0.0](/app/references/changelog#12-0-0), users can navigate to
469469
multiple domains in a single test.
470470

471471
:::
@@ -485,7 +485,7 @@ for more information and workarounds.
485485

486486
### <Icon name="exclamation-triangle" color="red" /> `cy.visit()` succeeded, but commands are timing out
487487

488-
As of Cypress [v12.0.0](https://on.cypress.io/changelog#12-0-0), users can
488+
As of Cypress [v12.0.0](/app/references/changelog#12-0-0), users can
489489
navigate to multiple domains in a single test. The following test will succeed
490490
as-is:
491491

@@ -851,7 +851,7 @@ regedit or gpedit.
851851
The `--auto-cancel-after-failures` flag is only available in Cypress 12.6.0 and
852852
later, and must be used with the `cypress run` command.
853853

854-
### <Icon name="exclamation-triangle" color="red" /> --auto-cancel-after-failures must be a integer or false
854+
### <Icon name="exclamation-triangle" color="red" /> --auto-cancel-after-failures must be an integer or false
855855

856856
You passed in an invalid value for the `--auto-cancel-after-failures` flag. It
857857
must be an integer or false.
@@ -869,8 +869,7 @@ Cancellation.
869869
You passed the `--auto-cancel-after-failures` flag, but this run originally
870870
started with a different value on this `--auto-cancel-after-failures` flag.
871871

872-
The first setting of `--auto-cancel-after-failures` for any given run takes
873-
precedent.
872+
The first setting of `--auto-cancel-after-failures` for any given run takes precedence.
874873

875874
## Page Load Errors
876875

docs/app/references/troubleshooting.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ You can check the current company policies for your Chrome installation by typin
9090
### Allow Cypress URLs on VPNs
9191

9292
To send the data and results of your tests to
93-
[Cypress Cloud](https://on.cypress.io/cloud-introduction), Cypress needs free
93+
[Cypress Cloud](/cloud/get-started/introduction), Cypress needs free
9494
access to some URLs.
9595

9696
<UrlAllowList />

docs/cloud/account-management/billing-and-usage.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ To qualify, all Projects in
3131
your Organization must meet the following criteria:
3232

3333
- Be a non-commercial entity
34-
- Be [Public](https://on.cypress.io/projects#Change-project-access) in Cypress
34+
- Be [Public](/cloud/account-management/projects#Change-project-access) in Cypress
3535
Cloud
3636
- Your Project source code is available in a public location with an
3737
[OSI-approved license](https://opensource.org/licenses)
3838
- Record minimum of 500
39-
[tests](https://on.cypress.io/cloud-faq#What-counts-as-a-test-result) included
39+
[tests](/cloud/faq#What-counts-as-a-test-result) included
4040
with the [Starter Plan](https://www.cypress.io/pricing)
4141

4242
### Requesting OSS plan for an Org

docs/partials/_anatomy-of-an-error.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Cypress test.
1111
4. **Code frame file**: This is usually the top line of the stack trace and it
1212
shows the file, line number, and column number that is highlighted in the
1313
code frame below. Clicking on this link will open the file in your
14-
[preferred file opener](https://on.cypress.io/IDE-integration#File-Opener-Preference)
14+
[preferred file opener](/app/tooling/IDE-integration#File-Opener-Preference)
1515
and highlight the line and column in editors that support it.
1616
5. **Code frame**: This shows a snippet of code where the failure occurred, with
1717
the relevant line and column highlighted.
1818
6. **View stack trace**: Clicking this toggles the visibility of the stack
1919
trace. Stack traces vary in length. Clicking on a blue file path will open
2020
the file in your
21-
[preferred file opener](https://on.cypress.io/IDE-integration#File-Opener-Preference).
21+
[preferred file opener](/app/tooling/IDE-integration#File-Opener-Preference).
2222
7. **Print to console button**: Click this to print the full error to your
2323
DevTools console. This will usually allow you to click on lines in the stack
2424
trace and open files in your DevTools.

docs/partials/_ci_provider_cloud_steps.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ https://github.com/facebook/docusaurus/issues/3915
55
TODO: reuse this bulk of text for now until the Docusaurus v3 refactor.
66
-->
77

8-
1. [Recording test results with the `--record` flag](https://on.cypress.io/how-do-i-record-runs)
8+
1. [Recording test results with the `--record` flag](/cloud/get-started/setup)
99
to Cypress Cloud.
1010

1111
- In-depth and shareable

docs/partials/_document-domain-workaround.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<Icon name="exclamation-triangle" /> **Disabling document.domain Injection**
44

55
In some cases, `document.domain` injection may cause issues. As of Cypress
6-
[v12.4.0](https://on.cypress.io/changelog#12-4-0), disabling `document.domain`
6+
[v12.4.0](/app/references/changelog#12-4-0), disabling `document.domain`
77
injection is available with the `experimentalSkipDomainInjection` option. Please
88
read about this
99
[experiment](/app/references/experiments#Experimental-Skip-Domain-Injection)

docs/ui-coverage/changelog.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ sidebar_position: 200
1313

1414
## Week of 9/30/2024
1515

16-
- **Slack Messages:** UI Coverage results results are now included in Slack messages alongside test results. [Learn more about our Slack integration here](https://on.cypress.io/slack-integration).
16+
- **Slack Messages:** UI Coverage results results are now included in Slack messages alongside test results. [Learn more about our Slack integration here](/cloud/integrations/slack).
1717

1818
## Week of 9/23/2024
1919

@@ -26,7 +26,7 @@ sidebar_position: 200
2626
## Week of 8/19/2024
2727

2828
- **Results API:** We have added the new [Results API](/ui-coverage/results-api) which enables you to programmatically fetch your run's UI Coverage results in a CI environment. This allows you to act the results within CI by allowing you to determine if the results are acceptable or need to be addressed before code changes can merge.
29-
- **Pull and Merge Request Comments:** UI Coverage results will now appear in [GitHub](https://on.cypress.io/github-integration), [GitLab](https://on.cypress.io/gitlab-integration) and [Bitbucket](https://on.cypress.io/bitbucket-integration) pull request and merge request comments alongside test results. Integrations can be installed and comments can be enabled in Project Settings.
29+
- **Pull and Merge Request Comments:** UI Coverage results will now appear in [GitHub](/cloud/integrations/source-control/github), [GitLab](/cloud/integrations/source-control/gitlab) and [Bitbucket](/cloud/integrations/source-control/bitbucket) pull request and merge request comments alongside test results. Integrations can be installed and comments can be enabled in Project Settings.
3030

3131
## Week of 8/12/2024
3232

docs/ui-coverage/core-concepts/interactivity.mdx

+20
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,23 @@ UI Coverage considers interactive elements "tested" if they are interacted with
3636
- `trigger`
3737
- `type`
3838
- `uncheck`
39+
40+
## Untested Links
41+
42+
UI Coverage tracks links (`<a>` elements) that haven't been visited during testing. For each untested link, you can see:
43+
44+
### Referrers
45+
46+
The Views containing links to this untested destination. This helps you understand:
47+
48+
- Where these untested areas are referenced from
49+
- The navigation paths that could lead to this untested area
50+
- The context in which these links appear
51+
52+
### URLs
53+
54+
Shows how similar URLs are grouped together. For example, if you have links to `/users/1`, `/users/2`, and `/users/3`, they'll be grouped as `/users/*`. The URLs section shows all the actual URLs that were grouped together. This is particularly useful for:
55+
56+
- Understanding the scope of dynamic routes in your application
57+
- Seeing how many variations of a URL pattern exist
58+
- Writing configuration rules to handle URL patterns appropriately

docs/ui-coverage/core-concepts/views.mdx

+23-7
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,30 @@ sidebar_position: 100
99

1010
<UICovAddon />
1111

12-
UI Coverage is organized into views, which are the unique URLs across all snapshots from end-to-end tests and the unique mounted components from component tests.
12+
UI Coverage organizes all unique URLs across snapshots from end-to-end tests and mounted components from component tests into "Views". A View represents a distinct page or state in your application.
1313

14-
### Grouping
14+
## View Creation & Grouping
1515

16-
UI Coverage uses certain default rules to generate a single view from dynamic URLs that represent the same page:
16+
By default, UI Coverage uses certain rules to generate a single View from dynamic URLs that represent the same page:
1717

18-
- All search parameters are removed.
19-
- All hash parameters are removed, unless the hash parameter starts with a `/`, such as `#/admin`.
20-
- If there are multiple URLs that are exactly the same except for a different integer or UUID value in the same path parameter, then that path parameter is replaced with a wildcard (`*`).
18+
- All search parameters are removed
19+
- Hash parameters are removed (unless they start with `/`, such as `#/admin`)
20+
- If multiple URLs differ only by an integer or UUID in the same path parameter, that parameter is replaced with a wildcard (`*`)
2121

22-
These rules can be overridden via [views](/ui-coverage/configuration/views) configuration.
22+
For example:
23+
24+
- `/users/123/profile` and `/users/456/profile` would be grouped into `/users/*/profile`
25+
- `/dashboard?tab=overview` and `/dashboard?tab=settings` would be grouped into `/dashboard`
26+
- `/app#settings` and `/app#profile` would be grouped into `/app`
27+
- `/app#/admin` and `/app#/settings` would remain separate Views
28+
29+
## Using Views
30+
31+
In the UI Coverage interface, Views are listed with their coverage scores, helping you:
32+
33+
- See which areas of your application have been tested
34+
- Identify untested pages and components
35+
- Track changes in coverage across different parts of your application
36+
- Focus testing efforts on critical paths and flows
37+
38+
You can customize how URLs are grouped into Views using [views](/ui-coverage/configuration/views) and [viewFilters](/ui-coverage/configuration/viewfilters) configuration options.

docs/ui-coverage/get-started/introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ UI Coverage captures "snapshots" of every page visited by your Cypress tests (an
5454

5555
As a result, a UI Coverage score is generated. This score quantifies coverage across your application by measuring the ratio of the unique elements that have been tested to the total unique elements that are found across your application.
5656

57-
Because Cypress Accessibility uses data captured through Cypress Test Replay, it is subject to any [limitations of Test Replay](https://docs.cypress.io/faq/questions/cloud-faq#Is-everything-captured-and-replayed-in-Test-Replay) data captured and browser support.
57+
Because Cypress UI Coverage uses data captured through Cypress Test Replay, it is subject to Test Replay limitations. Read [How Test Replay Works](/cloud/features/test-replay#How-Test-Replay-Works) to discover which data is captured and which browsers are supported.

0 commit comments

Comments
 (0)