Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions docs/guides/cloud/runs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,22 @@ title: Runs
sidebar_position: 30
---

Recorded runs capture the results from your test runs.
Recorded runs capture the results from your test runs. Each specific area of
this highly informative view is described below.

:::info
:::tip

If you haven't set up your project to record
[read here](/guides/cloud/projects#Setup).
&#8239<Icon name="check-circle" color="green" /> If you haven't set up your
project to record, [read here](/guides/cloud/projects#Setup).

:::

## Latest Runs

The Project entry point provides a high-level overview of your most recent runs.
This view presents a paginated summary of runs which are filterable and can be
manually refreshed in the top right corner.

## Run Details

On navigating to a specific run, you are presented with the Run Details page.
Expand All @@ -28,9 +35,9 @@ This page consists of a common header and four tabbed sub-pages,

At the left side of the header is important metadata about the run, including
git author and branch
[if available](/guides/continuous-integration/introduction#Git-information), run
time and duration, CI data and more. Clicking on the three dots to the right of
this section displays additional metadata, including browsers and operating
([if available](/guides/continuous-integration/introduction#Git-information)),
run time and duration, CI data and more. Clicking on the three dots to the right
of this section displays additional metadata, including browsers and operating
systems used, the Cypress version, and what
[Smart Orchestration](/guides/cloud/smart-orchestration) settings were active.

Expand Down Expand Up @@ -106,10 +113,10 @@ view, focusing attention on the specs producing the most relevant results.

It orders results by:

- Failed - when a failure occurred in the test or a hook associated with the
- **Failed** - when a failure occurred in the test or a hook associated with the
test
- Flaky - when a test failed one or more attempts before finally passing
- Modified - when the test body has changed from a previously recorded tests
- **Flaky** - when a test failed one or more attempts before finally passing
- **Modified** - when the test body has changed from a previously recorded tests

The panel shows these tests broken down by spec, with easy access to run
artifacts, and a badge clearly indicating the reason the result was considered
Expand All @@ -131,8 +138,6 @@ results by a wide range of metrics, like
[test statuses](/guides/core-concepts/writing-and-organizing-tests#Test-statuses)
or [flaky tests](/guides/cloud/flaky-test-management).

The

<DocsImage
src="/img/guides/cloud/runs/test-results.png"
alt="Test Results tab"
Expand All @@ -141,11 +146,14 @@ The
## Specs tab

Another way to look at your run is by "zooming out" to the spec file level,
which is the purpose of the Specs tab. This tab lets you view spec results
collected into [run groups](/guides/guides/parallelization#Grouping-test-runs),
focusing either on run order, spec duration or
[parallelization](/guides/guides/parallelization). You can switch between these
views using the Views button bar in the top right.
which is the purpose of the Specs tab. Remember, a spec file is a single file
that can contain one or more test(s).

This tab lets you view spec results collected into
[run groups](/guides/guides/parallelization#Grouping-test-runs). You can switch
between views, focusing either on run order, spec duration or
[parallelization](/guides/guides/parallelization) (per machine) using the Views
button bar in the top right.

In all of these views, spec results may be clicked to open those tests in the
Test Results tab.
Expand Down Expand Up @@ -208,7 +216,7 @@ time, performance breakdowns, listings of the test code itself, and more.

Contains the title of the failed test, and the spec it's located in. May also
have labels indicating test status or other pertinent information, and shortcuts
to raise tickets on integrated PM systems or view artifacts.
to raise tickets on integrated project management systems or view artifacts.

<DocsImage
src="/img/guides/cloud/runs/sidebar-header.png"
Expand Down Expand Up @@ -284,8 +292,6 @@ canceled by members of the project.
run details page
- Click **Yes, cancel this run** to confirm. **Note: this cannot be undone**

<DocsVideo src="/img/snippets/cancelling-run.mp4" title="Cloud cancel runs" />

### What happens when a run is canceled?

- The run status will update to canceled.
Expand All @@ -306,11 +312,7 @@ canceled by members of the project.
[cypress run --record](/guides/guides/command-line#cypress-run) for the run
will exit with an error like below.

<DocsImage
src="/img/dashboard/cancel-run-error.png"
alt="cancel-run-error"
width-600
/>
<DocsImage src="/img/dashboard/cancel-run-error.png" alt="cancel-run-error" />

## Archive run

Expand Down
5 changes: 2 additions & 3 deletions src/components/icon/index.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
import React from "react";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";

/* Note: Docusaurus/MDX v1 has parsing issues where some markdown renders statically and can cuse sibsequent links when beside a component or
HTML tag while NOT in a section header or table, etc. https://github.com/mdx-js/mdx/issues/1571#issuecomment-853384939
/* Note: Docusaurus/MDX v1 has parsing issues where some markdown renders statically when beside a component or HTML tag while NOT in a section header or table, etc. https://github.com/mdx-js/mdx/issues/1571#issuecomment-853384939

Exact issue here is noted here https://docusaurus.io/docs/markdown-features/react#markdown-and-jsx-interoperability.

This should be fixed when DS moves to MDX v2 https://github.com/facebook/docusaurus/issues/4029

For now, we we wrap the anchor in this component for reusability. Other in-line workarounds are add a narrow no-break space (#8239; or &nnbsp;) before the <Icon /> or replace markdown syntax with equivalient html tags. */
For now, we we wrap the anchor in this component for reusability. Other in-line workarounds are add a narrow no-break space (&#8239; or &nnbsp; or &nbsp; respectively) before the <Icon /> or replace markdown syntax with equivalent html tags. */

// TODO: refactor this component after DS moves to MDX v2.

Expand Down
2 changes: 1 addition & 1 deletion src/css/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ div[class^='codeBlockTitle'] {

/* adding this back after original Docusaurus
rules overwritten by .embedContainer
TODO: fix what casues this */
TODO: fix what causes this */
[class^='mainContentHeader'] {
border-bottom: 1px solid var(--ifm-toc-border-color);
margin-bottom: 20px;
Expand Down
3 changes: 1 addition & 2 deletions src/css/markdown.scss
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ div.markdown {
}
}

h2,
h4 {
h2 {
margin-bottom: 1.5rem;
padding-bottom: 0.5rem;
border-bottom: 2px solid var(--ifm-toc-border-color);
Expand Down
Binary file modified static/img/dashboard/cancel-run-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/guides/cloud/runs/run-details-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/guides/cloud/runs/sidebar-artifacts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/guides/cloud/runs/sidebar-errors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/snippets/cancelling-run.mp4
Binary file not shown.