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
{{ message }}
Repository navigation
Commit 2fc1c72
Browse filesBrowse the repository at this point in the historyBrowse files
docs(reports): deprecate allure and html-detailed for removal on 7 De… (#159)
* docs(reports): deprecate allure and html-detailed for removal on 7 December 2026
- Report Formats now has a warning: from 7 December 2026, html-detailed
gives the standard HTML report, allure gives no report, and runs still
run.
- The pages that list report formats mark both values as deprecated, with
the date. The Allure download examples now use the HTML report.
- The HTML report's default path is ./report.zip, as the CLI has used since
5.10.0. Several pages still said ./report.html.
* docs(reports): drop the note about CLIs before 5.10.0
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ There are first-class integrations for GitHub Actions, Bitrise, Bitbucket Pipeli
92
92
93
93
### How do I get videos, logs and test reports?
94
94
95
-
Pass `--download-artifacts ALL` (or `FAILED`) to a `dcd cloud` run, or fetch them after the fact with `dcd artifacts --upload-id <uuid> --download-artifacts ALL`. Each result in the console also has a download menu for its logs, reports, app binary and workspace. Reports are available as `junit`, `html`, `html-detailed` and `allure`via `--report`. See [Artifacts & Downloads](artifacts/artifacts.md) and [Report Formats](artifacts/report-formats.md).
95
+
Pass `--download-artifacts ALL` (or `FAILED`) to a `dcd cloud` run, or fetch them after the fact with `dcd artifacts --upload-id <uuid> --download-artifacts ALL`. Each result in the console also has a download menu for its logs, reports, app binary and workspace. Reports are available as `junit` and `html` via `--report`. `html-detailed` and `allure`are deprecated and will be removed on 7 December 2026. See [Artifacts & Downloads](artifacts/artifacts.md) and [Report Formats](artifacts/report-formats.md).
dcd artifacts --upload-id <uuid> --report html --html-path ./report.zip
46
46
```
47
47
48
48
See the [`dcd artifacts` reference](../cli/dcd-artifacts.md) for the full flag list.
49
49
50
50
### From the Console
51
51
52
-
Each test result in the [DeviceCloud console](https://console.devicecloud.dev) has a download menu with the files for that result: `commands.json`, the Maestro log, Maestro stdout and stderr, the logcat (Android), the HTML, JUnit and Allure reports (when the run generated them), the app binary (APK or APP build) and the workspace. Videos and screenshots are shown on the result page; to download them in bulk, use `--download-artifacts` or `dcd artifacts`.
52
+
Each test result in the [DeviceCloud console](https://console.devicecloud.dev) has a download menu with the files for that result: `commands.json`, the Maestro log, Maestro stdout and stderr, the logcat (Android), the HTML, JUnit and Allure reports (when the run generated them; Allure is deprecated and will be removed on 7 December 2026), the app binary (APK or APP build) and the workspace. Videos and screenshots are shown on the result page; to download them in bulk, use `--download-artifacts` or `dcd artifacts`.
Device Cloud supports the standard Maestro report formats as well as [Allure](https://allurereport.org/), a widely used open-source reporting framework that provides enhanced visualisation and history tracking.
3
+
Device Cloud supports the standard Maestro report formats: JUnit and HTML.
4
+
5
+
::: warning
6
+
`allure` and `html-detailed` are deprecated and **will be removed on 7 December 2026**. From that date, runs that pass them still run and don't fail:
7
+
8
+
-`--report html-detailed` gets the standard HTML report.
9
+
-`--report allure` gets no report.
10
+
11
+
To move now, use `--report html` or `--report junit`.
12
+
:::
4
13
5
14
## Available Reports
6
15
7
16
We support the following report types:
8
17
9
18
-`junit`
10
19
-`html`
11
-
-`html-detailed`
12
-
-`allure`
20
+
-`html-detailed` (deprecated, removed on 7 December 2026)
21
+
-`allure` (deprecated, removed on 7 December 2026)
13
22
14
23
You can enable each report using `--report <type>`.
15
24
16
25
The CLI will automatically download the report to your working directory for you after the run finishes. To change the download path, use the flag for that report format:
17
26
18
27
-`--junit-path <path>` (default `./report.xml`)
19
-
-`--html-path <path>` (default `./report.html`, applies to `html` and `html-detailed`)
28
+
-`--html-path <path>` (default `./report.zip`, applies to `html` and `html-detailed`)
20
29
-`--allure-path <path>` (default `./report.html`)
21
30
22
31
::: info
23
-
The `html` and `html-detailed` reports are downloaded as a ZIP archive (the report plus its screenshots, videos and logs), even though the default file name is `report.html`. Pass `--html-path ./report.zip` so the file has the right extension, then unzip it to view the report.
32
+
The `html` and `html-detailed` reports are downloaded as a ZIP archive (the report plus its screenshots, videos and logs). Unzip it to view the report.
24
33
:::
25
34
26
35
(`--artifacts-path` is a separate flag that sets the download path for the artifacts zip and requires `--download-artifacts`.)
@@ -33,8 +42,8 @@ JUnit reports are XML-based and are generally the standard format for CI/CD repo
33
42
34
43
### HTML and HTML-Detailed
35
44
36
-
HTML reports are human-readable provide a summary overview of a test run including failure screenshots. Detailed reports include test steps alongside everything from standard HTML reports. Both are delivered as a ZIP containing the report and the files it links to.
45
+
HTML reports are human-readable and provide a summary of a test run, including failure screenshots. Both are delivered as a ZIP containing the report and the files it links to. Detailed reports add the test steps to everything in a standard HTML report. `html-detailed` is deprecated: from 7 December 2026 it gives the standard HTML report.
37
46
38
47
### Allure
39
48
40
-
Allure reports are HTML-based and include rich and comprehensive visualisations of test results. They are downloaded as a single, self-contained HTML file. Read more [here](https://allurereport.org/).
49
+
Allure reports are HTML-based and are downloaded as a single, self-contained HTML file. Allure is deprecated and will be removed on 7 December 2026. From that date, runs that pass `--report allure` get no report. Use `html` or `junit` instead.
| `REPORT` | `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. See [Report Formats](../artifacts/report-formats.md). |
72
72
| `JUNIT_PATH` | Where to write the JUnit report (default `./report.xml`). |
73
73
| `DOWNLOAD_ARTIFACTS` | `ALL` or `FAILED` — downloads logs/screenshots/videos. |
| `--report <format>` | `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. See [Report Formats](../artifacts/report-formats.md). |
Copy file name to clipboardExpand all lines: ci-cd/github-actions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,7 +127,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag
127
127
| `env` | No | — | Multiline list of environment variables (`KEY=value`) to inject into flows. |
128
128
| `name` | No | PR title or commit message | Custom name for this test run, visible in the console. Defaults to the pull request's title on PR events, the commit message on push events, and the commit SHA otherwise. |
129
129
| `retry` | No | `0` | Number of retries on failure (max `2`). Retries are free — same as pressing retry in the UI. |
130
-
| `report` | No | — | Report format. Options: `junit`, `html`, and from v2.6.0 `html-detailed`. See [Report Formats](../artifacts/report-formats.md). |
130
+
| `report` | No | — | Report format. Options: `junit`, `html`, and from v2.6.0 `html-detailed`. `html-detailed` is deprecated and will be removed on 7 December 2026. See [Report Formats](../artifacts/report-formats.md). |
|`--report <format>`| Download a test report. Options: `junit`, `html`, `html-detailed`, `allure`. Mutually exclusive with `--download-artifacts`|
35
-
|`--allure-path <path>`| Output path for the Allure report (default: `./report.html`). Requires `--report allure`|
36
-
|`--html-path <path>`| Output path for the HTML report (default: `./report.html`). Requires `--report html` or `html-detailed`. The HTML report downloads as a ZIP, so use a `.zip` path such as `./report.zip`|
34
+
|`--report <format>`| Download a test report. Options: `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. Mutually exclusive with `--download-artifacts`|
35
+
|`--allure-path <path>`| Output path for the Allure report (default: `./report.html`). Requires `--report allure`. Deprecated, removed on 7 December 2026|
36
+
|`--html-path <path>`| Output path for the HTML report (default: `./report.zip`). Requires `--report html` or `html-detailed`. The HTML report downloads as a ZIP, so use a `.zip` path |
37
37
|`--junit-path <path>`| Output path for the JUnit report (default: `./report.xml`). Requires `--report junit`|
Copy file name to clipboardExpand all lines: cli/dcd-cloud.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,10 +110,10 @@ Attach Git and pull request metadata to a run. These values are displayed in the
110
110
|`--json-file`| Write JSON results to a file (`<upload_id>_dcd.json` by default). Exits `0` even if the test run fails; infrastructure errors still exit `1`|
111
111
|`--json-file-name <name>`| Custom name (or relative path) for the JSON file. Requires `--json-file`|
112
112
|`--dry-run`| Simulate the run without uploading or triggering a test — useful for debugging workflow issues |
113
-
|`--report <format>`, `--format`| Generate and download a report. Options: `junit`, `html`, `html-detailed`, `allure` (see [Report Formats](../artifacts/report-formats.md)) |
113
+
|`--report <format>`, `--format`| Generate and download a report. Options: `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026 (see [Report Formats](../artifacts/report-formats.md)) |
114
114
|`--junit-path <path>`| Output path for the JUnit report (requires `--report junit`) |
115
115
|`--html-path <path>`| Output path for the HTML report (requires `--report html` or `html-detailed`). The HTML report downloads as a ZIP, so use a `.zip` path such as `./report.zip`|
116
-
|`--allure-path <path>`| Output path for the Allure report (requires `--report allure`) |
116
+
|`--allure-path <path>`| Output path for the Allure report (requires `--report allure`). Deprecated, removed on 7 December 2026|
117
117
|`--download-artifacts <ALL\|FAILED>`| Download test artifacts after completion (see [Artifacts](../artifacts/artifacts.md)) |
118
118
|`--artifacts-path <path>`| Output path for the artifacts zip (default `./artifacts.zip`). Requires `--download-artifacts`|
Copy file name to clipboardExpand all lines: mcp/tools.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,8 +52,8 @@ Download a completed run's artifacts zip (videos, logs and screenshots) to local
52
52
|`uploadId`| string |**Required.** UUID of the upload to download artifacts for |
53
53
|`type`|`ALL`\|`FAILED`| Which tests to include artifacts for (default `ALL`) |
54
54
|`artifactsPath`| string | Where to write the artifacts zip (default `./artifacts.zip`) |
55
-
|`report`|`junit`\|`allure`\|`html`| Also download a formatted report of this type |
56
-
|`reportPath`| string | Where to write the report (defaults by type: `report.xml` for `junit`, otherwise `report.html`). The `html` report is a ZIP, so give it a `.zip` path|
55
+
|`report`|`junit`\|`allure`\|`html`| Also download a formatted report of this type. `allure` is deprecated and will be removed on 7 December 2026|
56
+
|`reportPath`| string | Where to write the report (defaults by type: `report.xml` for `junit`, `report.zip` for `html`, `report.html` for `allure`). The `html` report is a ZIP |
57
57
58
58
Returns `{ uploadId, artifactsPath, reportPath, warnings }`. A **non-empty `warnings` array means a download could not be produced** — most often because the run has no results yet. An empty array means success. See [Artifacts & Downloads](../artifacts/artifacts.md) and [Report Formats](../artifacts/report-formats.md).
0 commit comments