devicecloud-dev/Device Cloud Action

Uses devicecloud.dev to execute Maestro mobile tests

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
api-keyAPI key for devicecloud.dev (find this in the console UI). You can also set the DEVICE_CLOUD_API_KEY environment variable.yes
api-urlAPI URL for devicecloud.devno
app-fileApp binary to run your flows againstno
app-binary-idThe ID of the app binary previously uploaded to devicecloud.devno
android-api-level[Android only] Android API level to run your flow against <options: 29|30|31|32|33|34|35|36>no
android-device[Android only] Android device to run your flow against <options: pixel-6|pixel-6-pro|pixel-7|pixel-7-pro|generic-tablet>no
asyncImmediately return (exit code 0) from the command without waiting for the results of the run (useful for saving CI minutes)no
device-localeLocale that will be set to a device, ISO-639-1 code and uppercase ISO-3166-1 code e.g. "de_DE" for Germanyno
download-artifactsDownload a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use FAILED for failures only or ALL for every result. <options: ALL|FAILED>no
envOne or more environment variables to inject into your flowsno
json-fileWrite JSON output to a file with name <run_name>_dcd.json or <upload_id>_dcd.json if no name is providedno
exclude-flowsSub directories to ignore when building the flow file listno
exclude-tagsFlows which have these tags will be excluded from the runno
flowsThe path to the flow file or folder containing your flowsno
google-play[Android only] Run your flow against Google Play devicesno
ignore-sha-checkIgnore the sha hash check and upload the binary regardless of whether it already exists (not recommended)no
include-tagsOnly flows which have these tags will be included in the runno
ios-device[iOS only] iOS device to run your flow against <options: iphone-14|iphone-14-pro|iphone-15|iphone-15-pro|iphone-16|iphone-16-plus|iphone-16-pro|iphone-16-pro-max|ipad-pro-6th-gen>no
ios-version[iOS only] iOS version to run your flow against <options: 16|17|18|26>no
maestro-versionMaestro version to run your flow againstno
moropo-v1-api-keyAPI key for Moropo v1 integrationno
nameA custom name for your upload (useful for tagging commits etc)no
orientation[Android only] The orientation of the device to run your flow against in degrees <options: 0|90|180|270>no
quietQuieter console output that wont provide progress updatesno
reportRuns Maestro with the --format flag, this will generate a report in the specified format <options: junit|html|html-detailed>no
retryNumber of times to retry the run if it fails (same as pressing retry in the UI, this is free)no
workspaceThe path to the workspace folder containing your flowsno./.maestro/
configSpecific path to your maestro config fileno
runner-type[experimental] The type of runner to use <options: m1|m4> - note: anything other than default will incur premium pricing tiers. See https://docs.devicecloud.dev/reference/runner-type for more informationnodefault
debugEnable debug mode for more verbose outputno
use-betaUse the beta version of the DCD CLI instead of the latest stable versionno
maestro-chrome-onboarding[Android only] Force Maestro-based Chrome onboarding - note: this will slow your tests but can fix browser related crashes. See https://docs.devicecloud.dev/reference/chrome-onboarding for more information.no
android-no-snapshot[Android only] Force cold boot instead of using snapshot boot. This is automatically enabled for API 35+ but can be used to force cold boot on older API levels.no
disable-animationsDisable device animations during test execution. On Android, disables system animation scales. On iOS, enables Reduce Motion. Reduces CPU load and may improve test reliability.no
include-github-contextAutomatically attach GitHub/PR context (branch, SHA, PR number, PR URL, run ID, repo) to the test run as metadata. Set to "false" to opt out.notrue
namedescription
DEVICE_CLOUD_CONSOLE_URLURL to view the test results in the Device Cloud console
DEVICE_CLOUD_FLOW_RESULTSJSON array containing results for each flow, including name, status, and any errors
DEVICE_CLOUD_UPLOAD_STATUSStatus of the test run (PENDING, RUNNING, PASSED, FAILED, CANCELLED)
DEVICE_CLOUD_APP_BINARY_IDID of the uploaded app binary in Device Cloud