reactivecircus/android-emulator-runner
1
0
Fork 0
mirror of https://github.com/reactivecircus/android-emulator-runner.git synced 2026-09-05 03:29:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs.

Browse Source
This commit is contained in:
Yang Chen
2019-11-07 02:40:54 +11:00
parent 0e9243dd43
commit 383efaa0b3
3 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/test.yml → .github/workflows/workflow.yml
+1 -1
View File
@@ -1,4 +1,4 @@
name: "Test android-emulator-runner" name: Main workflow
on: on:
pull_request: pull_request:
push: push:
README.md
+12 -11
View File
@@ -1,24 +1,25 @@
# GitHub Action - Android Emulator Runner # GitHub Action - Android Emulator Runner
<p align="left">
<a href="https://github.com/ReactiveCircus/android-emulator-runner"><img alt="GitHub Actions status" src="https://github.com/ReactiveCircus/android-emulator-runner/workflows/Main%20workflow/badge.svg"></a>
</p>
A GitHub Action for installing, configuring and running Android Emulators on macOS virtual machines. A GitHub Action for installing, configuring and running Android Emulators on macOS virtual machines.
TODO TODO
This action must be run on a **macOS** VM, e.g. `macOS-latest` or `macOS-10.14`. 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** ## Usage
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
``` ```
TODO TODO
action.yml
+4 -4
View File
@@ -3,16 +3,16 @@ description: 'Installs, configures and starts an Android Emulator directly on ma
author: 'Reactive Circus' author: 'Reactive Circus'
inputs: inputs:
api-level: 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 required: true
target: target:
description: 'target of the system image - default of google_apis' description: 'target of the system image - default or google_apis'
default: 'default' default: 'default'
abi: 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' default: 'x86'
headless: 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' default: 'true'
runs: runs:
using: 'node12' using: 'node12'