diff --git a/.github/workflows/test.yml b/.github/workflows/workflow.yml similarity index 93% rename from .github/workflows/test.yml rename to .github/workflows/workflow.yml index 7877bd04..4e9c7944 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/workflow.yml @@ -1,4 +1,4 @@ -name: "Test android-emulator-runner" +name: Main workflow on: pull_request: push: diff --git a/README.md b/README.md index 43e253de..50611f8a 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ # GitHub Action - Android Emulator Runner +
+ A GitHub Action for installing, configuring and running Android Emulators on macOS virtual machines. TODO This action must be run on a **macOS** VM, e.g. `macOS-latest` or `macOS-10.14`. -## Inputs +## Configurations -### `api-level` +| **Input** | **Required** | **Default** | **Description** | +|-------------|--------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| `api-level` | Required | N/A | API level of the platform system image - e.g. 23 for Android Marshmallow, 29 for Android 10. **Minimum API level supported is 21**. | +| `target` | Optional | `default` | Target of the system image - `default` or `google_apis`. | +| `abi` | Optional | `x86` | CPU / ABI of the system image - `x86` or `x86_64`. | +| `headless` | Optional | `true` | Whether to launch emulator without UI - `true` or `false`. When set to `true` this is equivalent to running the emulator with `emulator -no-window`. | -**Required** - -The API level of the system image to be used for the emulator. E.g. `23` for Android 6.0 Marshmallow, `29` for Android 10. - -**Minimum API level supported is 21**. - -TODO - -## Example usage +## Usage ``` TODO diff --git a/action.yml b/action.yml index 60d403bb..c31ef4b6 100644 --- a/action.yml +++ b/action.yml @@ -3,16 +3,16 @@ description: 'Installs, configures and starts an Android Emulator directly on ma author: 'Reactive Circus' inputs: api-level: - description: 'API level of the system image - e.g. 23 for Android Marshmallow, 29 for Android 10' + description: 'API level of the platform and system image - e.g. 23 for Android Marshmallow, 29 for Android 10' required: true target: - description: 'target of the system image - default of google_apis' + description: 'target of the system image - default or google_apis' default: 'default' abi: - description: 'cpu/abi of the system image - x86 or x86_64' + description: 'CPU / ABI of the system image - x86 or x86_64' default: 'x86' headless: - description: 'whether to launch emulator in headless mode - true or false' + description: 'whether to launch emulator in without UI - true or false' default: 'true' runs: using: 'node12'