Skip to content

Commit ef329b1

Browse files
authored
Merge pull request #5118 from cypress-io/cloud-runs-revisions
Cloud runs page revisions
2 parents 907da70 + 845c196 commit ef329b1

File tree

9 files changed

+31
-31
lines changed

9 files changed

+31
-31
lines changed

docs/guides/cloud/runs.mdx

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,22 @@ title: Runs
33
sidebar_position: 30
44
---
55

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

8-
:::info
9+
:::tip
910

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

1314
:::
1415

16+
## Latest Runs
17+
18+
The Project entry point provides a high-level overview of your most recent runs.
19+
This view presents a paginated summary of runs which are filterable and can be
20+
manually refreshed in the top right corner.
21+
1522
## Run Details
1623

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

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

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

107114
It orders results by:
108115

109-
- Failed - when a failure occurred in the test or a hook associated with the
116+
- **Failed** - when a failure occurred in the test or a hook associated with the
110117
test
111-
- Flaky - when a test failed one or more attempts before finally passing
112-
- Modified - when the test body has changed from a previously recorded tests
118+
- **Flaky** - when a test failed one or more attempts before finally passing
119+
- **Modified** - when the test body has changed from a previously recorded tests
113120

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

134-
The
135-
136141
<DocsImage
137142
src="/img/guides/cloud/runs/test-results.png"
138143
alt="Test Results tab"
@@ -141,11 +146,14 @@ The
141146
## Specs tab
142147

143148
Another way to look at your run is by "zooming out" to the spec file level,
144-
which is the purpose of the Specs tab. This tab lets you view spec results
145-
collected into [run groups](/guides/guides/parallelization#Grouping-test-runs),
146-
focusing either on run order, spec duration or
147-
[parallelization](/guides/guides/parallelization). You can switch between these
148-
views using the Views button bar in the top right.
149+
which is the purpose of the Specs tab. Remember, a spec file is a single file
150+
that can contain one or more test(s).
151+
152+
This tab lets you view spec results collected into
153+
[run groups](/guides/guides/parallelization#Grouping-test-runs). You can switch
154+
between views, focusing either on run order, spec duration or
155+
[parallelization](/guides/guides/parallelization) (per machine) using the Views
156+
button bar in the top right.
149157

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

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

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

287-
<DocsVideo src="/img/snippets/cancelling-run.mp4" title="Cloud cancel runs" />
288-
289295
### What happens when a run is canceled?
290296

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

309-
<DocsImage
310-
src="/img/dashboard/cancel-run-error.png"
311-
alt="cancel-run-error"
312-
width-600
313-
/>
315+
<DocsImage src="/img/dashboard/cancel-run-error.png" alt="cancel-run-error" />
314316

315317
## Archive run
316318

src/components/icon/index.tsx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
import React from "react";
22
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
33

4-
/* Note: Docusaurus/MDX v1 has parsing issues where some markdown renders statically and can cuse sibsequent links when beside a component or
5-
HTML tag while NOT in a section header or table, etc. https://github.com/mdx-js/mdx/issues/1571#issuecomment-853384939
4+
/* 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
65
76
Exact issue here is noted here https://docusaurus.io/docs/markdown-features/react#markdown-and-jsx-interoperability.
87
98
This should be fixed when DS moves to MDX v2 https://github.com/facebook/docusaurus/issues/4029
109
11-
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. */
10+
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. */
1211

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

src/css/custom.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ div[class^='codeBlockTitle'] {
311311

312312
/* adding this back after original Docusaurus
313313
rules overwritten by .embedContainer
314-
TODO: fix what casues this */
314+
TODO: fix what causes this */
315315
[class^='mainContentHeader'] {
316316
border-bottom: 1px solid var(--ifm-toc-border-color);
317317
margin-bottom: 20px;

src/css/markdown.scss

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ div.markdown {
3333
}
3434
}
3535

36-
h2,
37-
h4 {
36+
h2 {
3837
margin-bottom: 1.5rem;
3938
padding-bottom: 0.5rem;
4039
border-bottom: 2px solid var(--ifm-toc-border-color);
-13.4 KB
Loading
-2.39 KB
Loading
-314 Bytes
Loading
-8.86 KB
Loading
-578 KB
Binary file not shown.

0 commit comments

Comments
 (0)