Skip to content

Commit 1520e93

Browse files
madispmadisp
authored
chore: reorder inputs into logical groups (#11)
* chore: reorder inputs into logical groups * fix: grammar
1 parent 61c89f6 commit 1520e93

File tree

2 files changed

+110
-89
lines changed

2 files changed

+110
-89
lines changed

‎README.md‎

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -38,39 +38,41 @@ jobs:
3838
3939
## Inputs
4040
41-
| Variable | Description |
42-
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------|
43-
| `version` | ew-cli version to use |
44-
| `api-token` | API token for emulator.wtf. We recommend using a secret for this. |
45-
| `app` | Path to application apk file |
46-
| `test` | Path to test apk file |
47-
| `library-test` | Path to library test apk file |
48-
| `outputs-dir` | Location to store test outputs in |
49-
| `outputs` | Comma-separated list to specify what to download to output-dir. Defaults to `merged_results_xml,coverage,pulled_dirs`. |
50-
| `record-video` | Set to true to record a video of the test run. Defaults to false. |
51-
| `devices` | Device configurations to use, in the form of `model=X,version=Y` per line |
52-
| `timeout` | Timeout for the test run, number with unit (`h`, `m` or `s`). Defaults to 15m. |
53-
| `test-targets` | Test targets to run, e.g. `class foo.bar.Baz` will only run tests in that class |
54-
| `use-orchestrator` | Whether to use the Android Test Orchestrator |
55-
| `clear-package-data` | Whether to clear app data between every test (requires `use-orchestrator`) |
56-
| `with-coverage` | Set to true to collect coverage files and save them to `outputs-dir` |
57-
| `additional-apks` | Additional apks to install, one per line |
58-
| `environment-variables` | Environment variables to pass to AndroidJUnitRunner, one per line in the form of `key=value` |
59-
| `num-uniform-shards` | Set to a number larger than 1 to randomly split your tests into multiple shards to be executed in parallel |
60-
| `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 |
61-
| `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 |
62-
| `shard-target-runtime` | Target a specific runtime (in minutes), this will spawn as many shards as needed to hit the target runtime. |
63-
| `directories-to-pull` | Directories to pull from device and store in `outputs-dir`, one per line |
64-
| `side-effects` | Whether the test has any side effects, like hitting external APIs. Prevents any test caching and retries. |
65-
| `num-flaky-test-attempts` | Number of times to retry flaky tests. Defaults to 0. |
66-
| `flaky-test-repeat-mode` | Whether to repeat only flaky tests (failed_only) or full shards (all) with flaky test attempts. Defaults to failed_only. |
67-
| `file-cache` | Whether to cache files between test runs. Defaults to true. |
68-
| `file-cache-ttl` | How long to cache test files for. Defaults to 1h. |
69-
| `test-cache` | Whether to cache test results between test runs. Defaults to true. |
70-
| `proxy-host` | Configure a proxy host to use for all requests when making emulator.wtf API calls. |
71-
| `proxy-port` | Configure a proxy port to use for all requests when making emulator.wtf API calls. |
72-
| `proxy-user` | Set the proxy user to use for authentication. |
73-
| `proxy-password` | Set the proxy password to use for authentication. |
41+
| Variable | Description |
42+
|----------------------------|----------------------------------------------------------------------------------------------------------------------------------|
43+
| `version` | ew-cli version to use |
44+
| `api-token` | API token for emulator.wtf. We recommend using a secret for this. |
45+
| `app` | Path to application apk file |
46+
| `test` | Path to test apk file |
47+
| `library-test` | Path to library test apk file |
48+
| `additional-apks` | Additional apks to install, one per line |
49+
| `file-cache-ttl` | How long to cache test files for. Defaults to 1h. |
50+
| `file-cache` | Whether to cache files between test runs. Defaults to true. |
51+
| `display-name` | Display name for the test run |
52+
| `devices` | Device configurations to use, in the form of `model=X,version=Y` per line |
53+
| `use-orchestrator` | Whether to use the Android Test Orchestrator |
54+
| `clear-package-data` | Whether to clear app data between every test (requires `use-orchestrator`) |
55+
| `num-flaky-test-attempts` | Number of times to retry flaky tests. Defaults to 0. |
56+
| `flaky-test-repeat-mode` | Whether to repeat only flaky tests (failed_only) or full shards (all) with flaky test attempts. Defaults to failed_only. |
57+
| `timeout` | Timeout for the test run, number with unit (`h`, `m` or `s`). Defaults to 15m. |
58+
| `test-targets` | Test targets to run, e.g. `class foo.bar.Baz` will only run tests in that class |
59+
| `environment-variables` | Environment variables to pass to AndroidJUnitRunner, one per line in the form of `key=value` |
60+
| `test-cache` | Whether to cache test results between test runs. Defaults to true. |
61+
| `side-effects` | Whether the test has any side effects, like hitting external APIs. Prevents any test caching and retries. |
62+
| `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 |
63+
| `shard-target-runtime` | Target a specific runtime (in minutes), this will spawn as many shards as needed to hit the target runtime. |
64+
| `num-uniform-shards` | Set to a number larger than 1 to randomly split your tests into multiple shards to be executed in parallel |
65+
| `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 |
66+
| `record-video` | Set to true to record a video of the test run. Defaults to false. |
67+
| `with-coverage` | Set to true to collect coverage files and save them to `outputs-dir` |
68+
| `directories-to-pull` | Directories to pull from device and store in `outputs-dir`, one per line |
69+
| `outputs` | Comma-separated list to specify what to download to output-dir. Defaults to `merged_results_xml,coverage,pulled_dirs`. |
70+
| `outputs-dir` | Location to store test outputs in |
71+
| `proxy-host` | Configure a proxy host to use for all requests when making emulator.wtf API calls. |
72+
| `proxy-port` | Configure a proxy port to use for all requests when making emulator.wtf API calls. |
73+
| `proxy-user` | Set the proxy user to use for authentication. |
74+
| `proxy-password` | Set the proxy password to use for authentication. |
75+
| `async` | Run the test asynchronously, without waiting for the results. Useful if you're using the GitHub integration with check statuses. |
7476

7577
## Common examples
7678

0 commit comments

Comments
 (0)