From 592123dd3e20fb2095dfb3d5ce0ad12b159f5be1 Mon Sep 17 00:00:00 2001 From: finalerock44 Date: Thu, 5 Nov 2026 14:45:16 +0000 Subject: [PATCH 1/2] 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. --- README.md | 2 +- artifacts/artifacts.md | 6 +++--- artifacts/report-formats.md | 23 ++++++++++++++++------- ci-cd/bitbucket-pipelines.md | 2 +- ci-cd/eas-workflows.md | 2 +- ci-cd/github-actions.md | 2 +- cli/dcd-artifacts.md | 10 +++++----- cli/dcd-cloud.md | 4 ++-- mcp/tools.md | 4 ++-- 9 files changed, 32 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 2503ddb..9411e06 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ There are first-class integrations for GitHub Actions, Bitrise, Bitbucket Pipeli ### How do I get videos, logs and test reports? -Pass `--download-artifacts ALL` (or `FAILED`) to a `dcd cloud` run, or fetch them after the fact with `dcd artifacts --upload-id --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). +Pass `--download-artifacts ALL` (or `FAILED`) to a `dcd cloud` run, or fetch them after the fact with `dcd artifacts --upload-id --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). ### Is there a time limit on a test? diff --git a/artifacts/artifacts.md b/artifacts/artifacts.md index e80b9d3..2957260 100644 --- a/artifacts/artifacts.md +++ b/artifacts/artifacts.md @@ -41,15 +41,15 @@ dcd artifacts --upload-id --download-artifacts ALL # Download a JUnit report dcd artifacts --upload-id --report junit -# Download an Allure report -dcd artifacts --upload-id --report allure --allure-path ./allure-report.html +# Download the HTML report +dcd artifacts --upload-id --report html --html-path ./report.zip ``` See the [`dcd artifacts` reference](../cli/dcd-artifacts.md) for the full flag list. ### From the Console -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`. +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`. ## Artifact Archive Structure diff --git a/artifacts/report-formats.md b/artifacts/report-formats.md index 5a5c0bc..b5c9b3e 100644 --- a/artifacts/report-formats.md +++ b/artifacts/report-formats.md @@ -1,6 +1,15 @@ # Report Formats -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. +Device Cloud supports the standard Maestro report formats: JUnit and HTML. + +::: warning +`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: + +- `--report html-detailed` gets the standard HTML report. +- `--report allure` gets no report. + +To move now, use `--report html` or `--report junit`. +::: ## Available Reports @@ -8,19 +17,19 @@ We support the following report types: - `junit` - `html` -- `html-detailed` -- `allure` +- `html-detailed` (deprecated, removed on 7 December 2026) +- `allure` (deprecated, removed on 7 December 2026) You can enable each report using `--report `. 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: - `--junit-path ` (default `./report.xml`) -- `--html-path ` (default `./report.html`, applies to `html` and `html-detailed`) +- `--html-path ` (default `./report.zip`, applies to `html` and `html-detailed`) - `--allure-path ` (default `./report.html`) ::: info -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. +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. CLI versions before 5.10.0 name the file `report.html` by default, so with those, pass `--html-path ./report.zip` to give it the right extension. ::: (`--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 ### HTML and HTML-Detailed -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. +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. ### Allure -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/). \ No newline at end of file +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. diff --git a/ci-cd/bitbucket-pipelines.md b/ci-cd/bitbucket-pipelines.md index 87bbdaa..33afef7 100644 --- a/ci-cd/bitbucket-pipelines.md +++ b/ci-cd/bitbucket-pipelines.md @@ -68,7 +68,7 @@ Most pipe variables map to the [`dcd cloud`](../cli/dcd-cloud.md) CLI flag of th | `IOS_DEVICE`, `IOS_VERSION` | iOS device + version. | | `ENV_LIST` | Newline-separated `KEY=VALUE` env vars injected into flows. | | `INCLUDE_TAGS` / `EXCLUDE_TAGS` | Filter flows by Maestro tag. | -| `REPORT` | `junit`, `html`, `html-detailed`, `allure`. | +| `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). | | `JUNIT_PATH` | Where to write the JUnit report (default `./report.xml`). | | `DOWNLOAD_ARTIFACTS` | `ALL` or `FAILED` — downloads logs/screenshots/videos. | | `ASYNC` | `"true"` to fire-and-forget. | diff --git a/ci-cd/eas-workflows.md b/ci-cd/eas-workflows.md index 77bb8c2..6690eb7 100644 --- a/ci-cd/eas-workflows.md +++ b/ci-cd/eas-workflows.md @@ -222,7 +222,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag | `--env KEY=value` | Inject environment variables into your flows. Repeatable. | | `--name ` | Custom name for this test run. | | `--retry ` | Number of automatic retries on failure (max `2`). Retries are free. | -| `--report ` | `junit`, `html`, `html-detailed`, `allure`. See [Report Formats](../artifacts/report-formats.md). | +| `--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). | ### Execution Options diff --git a/ci-cd/github-actions.md b/ci-cd/github-actions.md index 43db98a..80358ae 100644 --- a/ci-cd/github-actions.md +++ b/ci-cd/github-actions.md @@ -127,7 +127,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag | `env` | No | — | Multiline list of environment variables (`KEY=value`) to inject into flows. | | `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. | | `retry` | No | `0` | Number of retries on failure (max `2`). Retries are free — same as pressing retry in the UI. | -| `report` | No | — | Report format. Options: `junit`, `html`, and from v2.6.0 `html-detailed`. See [Report Formats](../artifacts/report-formats.md). | +| `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). | ### Android-Specific Options diff --git a/cli/dcd-artifacts.md b/cli/dcd-artifacts.md index 92c5dc7..3d666dc 100644 --- a/cli/dcd-artifacts.md +++ b/cli/dcd-artifacts.md @@ -31,9 +31,9 @@ dcd artifacts --upload-id [flags] | Flag | Description | |------|-------------| -| `--report ` | Download a test report. Options: `junit`, `html`, `html-detailed`, `allure`. Mutually exclusive with `--download-artifacts` | -| `--allure-path ` | Output path for the Allure report (default: `./report.html`). Requires `--report allure` | -| `--html-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` | +| `--report ` | 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` | +| `--allure-path ` | Output path for the Allure report (default: `./report.html`). Requires `--report allure`. Deprecated, removed on 7 December 2026 | +| `--html-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 | | `--junit-path ` | Output path for the JUnit report (default: `./report.xml`). Requires `--report junit` | ### Other @@ -59,9 +59,9 @@ dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --download-artifa dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report junit ``` -**Download an Allure report to a custom path:** +**Download the HTML report to a custom path:** ```bash -dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report allure --allure-path ./allure-report.html +dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report html --html-path ./html-report.zip ``` ## Using with Async Runs diff --git a/cli/dcd-cloud.md b/cli/dcd-cloud.md index dcbf2a7..ea9f871 100644 --- a/cli/dcd-cloud.md +++ b/cli/dcd-cloud.md @@ -110,10 +110,10 @@ Attach Git and pull request metadata to a run. These values are displayed in the | `--json-file` | Write JSON results to a file (`_dcd.json` by default). Exits `0` even if the test run fails; infrastructure errors still exit `1` | | `--json-file-name ` | Custom name (or relative path) for the JSON file. Requires `--json-file` | | `--dry-run` | Simulate the run without uploading or triggering a test — useful for debugging workflow issues | -| `--report `, `--format` | Generate and download a report. Options: `junit`, `html`, `html-detailed`, `allure` (see [Report Formats](../artifacts/report-formats.md)) | +| `--report `, `--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)) | | `--junit-path ` | Output path for the JUnit report (requires `--report junit`) | | `--html-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` | -| `--allure-path ` | Output path for the Allure report (requires `--report allure`) | +| `--allure-path ` | Output path for the Allure report (requires `--report allure`). Deprecated, removed on 7 December 2026 | | `--download-artifacts ` | Download test artifacts after completion (see [Artifacts](../artifacts/artifacts.md)) | | `--artifacts-path ` | Output path for the artifacts zip (default `./artifacts.zip`). Requires `--download-artifacts` | | `--debug` | Enable verbose debug logging | diff --git a/mcp/tools.md b/mcp/tools.md index bdcd99d..f34fead 100644 --- a/mcp/tools.md +++ b/mcp/tools.md @@ -52,8 +52,8 @@ Download a completed run's artifacts zip (videos, logs and screenshots) to local | `uploadId` | string | **Required.** UUID of the upload to download artifacts for | | `type` | `ALL` \| `FAILED` | Which tests to include artifacts for (default `ALL`) | | `artifactsPath` | string | Where to write the artifacts zip (default `./artifacts.zip`) | -| `report` | `junit` \| `allure` \| `html` | Also download a formatted report of this type | -| `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 | +| `report` | `junit` \| `allure` \| `html` | Also download a formatted report of this type. `allure` is deprecated and will be removed on 7 December 2026 | +| `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 | 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). From e2835efa86abaefdb293c9e639a2aabbe485c466 Mon Sep 17 00:00:00 2001 From: finalerock44 Date: Thu, 5 Nov 2026 14:53:27 +0000 Subject: [PATCH 2/2] docs(reports): drop the note about CLIs before 5.10.0 --- artifacts/report-formats.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/artifacts/report-formats.md b/artifacts/report-formats.md index b5c9b3e..c1ea936 100644 --- a/artifacts/report-formats.md +++ b/artifacts/report-formats.md @@ -29,7 +29,7 @@ The CLI will automatically download the report to your working directory for you - `--allure-path ` (default `./report.html`) ::: info -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. CLI versions before 5.10.0 name the file `report.html` by default, so with those, pass `--html-path ./report.zip` to give it the right extension. +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. ::: (`--artifacts-path` is a separate flag that sets the download path for the artifacts zip and requires `--download-artifacts`.)