Skip to content

Commit 2fc1c72

Browse files
authored
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
1 parent 015e11b commit 2fc1c72

9 files changed

Lines changed: 32 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ There are first-class integrations for GitHub Actions, Bitrise, Bitbucket Pipeli
9292

9393
### How do I get videos, logs and test reports?
9494

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).
9696

9797
### Is there a time limit on a test?
9898

‎artifacts/artifacts.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ dcd artifacts --upload-id <uuid> --download-artifacts ALL
4141
# Download a JUnit report
4242
dcd artifacts --upload-id <uuid> --report junit
4343

44-
# Download an Allure report
45-
dcd artifacts --upload-id <uuid> --report allure --allure-path ./allure-report.html
44+
# Download the HTML report
45+
dcd artifacts --upload-id <uuid> --report html --html-path ./report.zip
4646
```
4747

4848
See the [`dcd artifacts` reference](../cli/dcd-artifacts.md) for the full flag list.
4949

5050
### From the Console
5151

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`.
5353

5454
## Artifact Archive Structure
5555

‎artifacts/report-formats.md‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
11
# Report Formats
22

3-
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+
:::
413

514
## Available Reports
615

716
We support the following report types:
817

918
- `junit`
1019
- `html`
11-
- `html-detailed`
12-
- `allure`
20+
- `html-detailed` (deprecated, removed on 7 December 2026)
21+
- `allure` (deprecated, removed on 7 December 2026)
1322

1423
You can enable each report using `--report <type>`.
1524

1625
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:
1726

1827
- `--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`)
2029
- `--allure-path <path>` (default `./report.html`)
2130

2231
::: 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.
2433
:::
2534

2635
(`--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
3342

3443
### HTML and HTML-Detailed
3544

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.
3746

3847
### Allure
3948

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.

‎ci-cd/bitbucket-pipelines.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Most pipe variables map to the [`dcd cloud`](../cli/dcd-cloud.md) CLI flag of th
6868
| `IOS_DEVICE`, `IOS_VERSION` | iOS device + version. |
6969
| `ENV_LIST` | Newline-separated `KEY=VALUE` env vars injected into flows. |
7070
| `INCLUDE_TAGS` / `EXCLUDE_TAGS` | Filter flows by Maestro tag. |
71-
| `REPORT` | `junit`, `html`, `html-detailed`, `allure`. |
71+
| `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). |
7272
| `JUNIT_PATH` | Where to write the JUnit report (default `./report.xml`). |
7373
| `DOWNLOAD_ARTIFACTS` | `ALL` or `FAILED` — downloads logs/screenshots/videos. |
7474
| `ASYNC` | `"true"` to fire-and-forget. |

‎ci-cd/eas-workflows.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag
222222
| `--env KEY=value` | Inject environment variables into your flows. Repeatable. |
223223
| `--name <name>` | Custom name for this test run. |
224224
| `--retry <n>` | Number of automatic retries on failure (max `2`). Retries are free. |
225-
| `--report <format>` | `junit`, `html`, `html-detailed`, `allure`. See [Report Formats](../artifacts/report-formats.md). |
225+
| `--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). |
226226

227227
### Execution Options
228228

‎ci-cd/github-actions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag
127127
| `env` | No | — | Multiline list of environment variables (`KEY=value`) to inject into flows. |
128128
| `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. |
129129
| `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). |
131131

132132
### Android-Specific Options
133133

‎cli/dcd-artifacts.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ dcd artifacts --upload-id <id> [flags]
3131

3232
| Flag | Description |
3333
|------|-------------|
34-
| `--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 |
3737
| `--junit-path <path>` | Output path for the JUnit report (default: `./report.xml`). Requires `--report junit` |
3838

3939
### Other
@@ -59,9 +59,9 @@ dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --download-artifa
5959
dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report junit
6060
```
6161

62-
**Download an Allure report to a custom path:**
62+
**Download the HTML report to a custom path:**
6363
```bash
64-
dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report allure --allure-path ./allure-report.html
64+
dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report html --html-path ./html-report.zip
6565
```
6666

6767
## Using with Async Runs

‎cli/dcd-cloud.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ Attach Git and pull request metadata to a run. These values are displayed in the
110110
| `--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` |
111111
| `--json-file-name <name>` | Custom name (or relative path) for the JSON file. Requires `--json-file` |
112112
| `--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)) |
114114
| `--junit-path <path>` | Output path for the JUnit report (requires `--report junit`) |
115115
| `--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 |
117117
| `--download-artifacts <ALL\|FAILED>` | Download test artifacts after completion (see [Artifacts](../artifacts/artifacts.md)) |
118118
| `--artifacts-path <path>` | Output path for the artifacts zip (default `./artifacts.zip`). Requires `--download-artifacts` |
119119
| `--debug` | Enable verbose debug logging |

‎mcp/tools.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Download a completed run's artifacts zip (videos, logs and screenshots) to local
5252
| `uploadId` | string | **Required.** UUID of the upload to download artifacts for |
5353
| `type` | `ALL` \| `FAILED` | Which tests to include artifacts for (default `ALL`) |
5454
| `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 |
5757

5858
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).
5959

0 commit comments

Comments
 (0)