Skip to content

chore: reorder inputs into logical groups #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
madisp merged 2 commits into from
Oct 17, 2025
Merged

chore: reorder inputs into logical groups #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af24d2f
chore: reorder inputs into logical groups
madisp Oct 17, 2025
df76e83
fix: grammar
madisp Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 35 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,39 +38,41 @@ jobs:

## Inputs

| Variable | Description |
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| `version` | ew-cli version to use |
| `api-token` | API token for emulator.wtf. We recommend using a secret for this. |
| `app` | Path to application apk file |
| `test` | Path to test apk file |
| `library-test` | Path to library test apk file |
| `outputs-dir` | Location to store test outputs in |
| `outputs` | Comma-separated list to specify what to download to output-dir. Defaults to `merged_results_xml,coverage,pulled_dirs`. |
| `record-video` | Set to true to record a video of the test run. Defaults to false. |
| `devices` | Device configurations to use, in the form of `model=X,version=Y` per line |
| `timeout` | Timeout for the test run, number with unit (`h`, `m` or `s`). Defaults to 15m. |
| `test-targets` | Test targets to run, e.g. `class foo.bar.Baz` will only run tests in that class |
| `use-orchestrator` | Whether to use the Android Test Orchestrator |
| `clear-package-data` | Whether to clear app data between every test (requires `use-orchestrator`) |
| `with-coverage` | Set to true to collect coverage files and save them to `outputs-dir` |
| `additional-apks` | Additional apks to install, one per line |
| `environment-variables` | Environment variables to pass to AndroidJUnitRunner, one per line in the form of `key=value` |
| `num-uniform-shards` | Set to a number larger than 1 to randomly split your tests into multiple shards to be executed in parallel |
| `num-shards` | Set to a number larger than 1 to split your tests into multiple shards based on test counts to be executed in parallel |
| `num-balanced-shards` | Set to a number larger than 1 to split your tests into multiple shards based on test execution time to be executed in parallel |
| `shard-target-runtime` | Target a specific runtime (in minutes), this will spawn as many shards as needed to hit the target runtime. |
| `directories-to-pull` | Directories to pull from device and store in `outputs-dir`, one per line |
| `side-effects` | Whether the test has any side effects, like hitting external APIs. Prevents any test caching and retries. |
| `num-flaky-test-attempts` | Number of times to retry flaky tests. Defaults to 0. |
| `flaky-test-repeat-mode` | Whether to repeat only flaky tests (failed_only) or full shards (all) with flaky test attempts. Defaults to failed_only. |
| `file-cache` | Whether to cache files between test runs. Defaults to true. |
| `file-cache-ttl` | How long to cache test files for. Defaults to 1h. |
| `test-cache` | Whether to cache test results between test runs. Defaults to true. |
| `proxy-host` | Configure a proxy host to use for all requests when making emulator.wtf API calls. |
| `proxy-port` | Configure a proxy port to use for all requests when making emulator.wtf API calls. |
| `proxy-user` | Set the proxy user to use for authentication. |
| `proxy-password` | Set the proxy password to use for authentication. |
| Variable | Description |
|----------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| `version` | ew-cli version to use |
| `api-token` | API token for emulator.wtf. We recommend using a secret for this. |
| `app` | Path to application apk file |
| `test` | Path to test apk file |
| `library-test` | Path to library test apk file |
| `additional-apks` | Additional apks to install, one per line |
| `file-cache-ttl` | How long to cache test files for. Defaults to 1h. |
| `file-cache` | Whether to cache files between test runs. Defaults to true. |
| `display-name` | Display name for the test run |
| `devices` | Device configurations to use, in the form of `model=X,version=Y` per line |
| `use-orchestrator` | Whether to use the Android Test Orchestrator |
| `clear-package-data` | Whether to clear app data between every test (requires `use-orchestrator`) |
| `num-flaky-test-attempts` | Number of times to retry flaky tests. Defaults to 0. |
| `flaky-test-repeat-mode` | Whether to repeat only flaky tests (failed_only) or full shards (all) with flaky test attempts. Defaults to failed_only. |
| `timeout` | Timeout for the test run, number with unit (`h`, `m` or `s`). Defaults to 15m. |
| `test-targets` | Test targets to run, e.g. `class foo.bar.Baz` will only run tests in that class |
| `environment-variables` | Environment variables to pass to AndroidJUnitRunner, one per line in the form of `key=value` |
| `test-cache` | Whether to cache test results between test runs. Defaults to true. |
| `side-effects` | Whether the test has any side effects, like hitting external APIs. Prevents any test caching and retries. |
| `num-balanced-shards` | Set to a number larger than 1 to split your tests into multiple shards based on test execution time to be executed in parallel |
| `shard-target-runtime` | Target a specific runtime (in minutes), this will spawn as many shards as needed to hit the target runtime. |
| `num-uniform-shards` | Set to a number larger than 1 to randomly split your tests into multiple shards to be executed in parallel |
| `num-shards` | Set to a number larger than 1 to split your tests into multiple shards based on test counts to be executed in parallel |
| `record-video` | Set to true to record a video of the test run. Defaults to false. |
| `with-coverage` | Set to true to collect coverage files and save them to `outputs-dir` |
| `directories-to-pull` | Directories to pull from device and store in `outputs-dir`, one per line |
| `outputs` | Comma-separated list to specify what to download to output-dir. Defaults to `merged_results_xml,coverage,pulled_dirs`. |
| `outputs-dir` | Location to store test outputs in |
| `proxy-host` | Configure a proxy host to use for all requests when making emulator.wtf API calls. |
| `proxy-port` | Configure a proxy port to use for all requests when making emulator.wtf API calls. |
| `proxy-user` | Set the proxy user to use for authentication. |
| `proxy-password` | Set the proxy password to use for authentication. |
| `async` | Run the test asynchronously, without waiting for the results. Useful if you're using the GitHub integration with check statuses. |

## Common examples

Expand Down
Loading