2020-07-14 15:41:00 +00:00
# setup-android
2020-01-03 10:37:01 +00:00
2020-08-17 17:44:06 +00:00
This action sets up the Android SDK tools by:
2024-11-09 21:40:34 +00:00
- Downloading the SDK commandline tools, if the current version (16.0) is not found in either `$ANDROID_SDK_ROOT` or `$HOME/.android/sdk` .
2022-08-03 13:44:44 +00:00
- Accepting the SDK licenses.
- Installing `tools` and `platform-tools` .
2024-11-09 21:40:34 +00:00
- Adding `platform-tools` (contains adb) and `cmdline-tools/16.0/bin` (contains sdkmanager) to `$PATH` .
2022-08-03 13:44:44 +00:00
- Setting up problem [matchers ](/matchers.json ).
On Windows 2016 runners, this action also checks if `$ANDROID_SDK_ROOT` path contains spaces.
If it does - it moves SDK to a path without spaces. This is needed because spaces are highly problematic:
```
C:\windows\system32\cmd.exe /D /S /C ""C:\Program Files (x86)\Android\android-sdk\cmdline-tools\3.0\bin\sdkmanager.bat" --licenses"
Error: Could not find or load main class Files
```
2020-08-17 17:44:06 +00:00
# Usage
See [action.yml ](action.yml )
## Basic
```yaml
steps:
2023-11-21 19:25:09 +00:00
- uses: actions/checkout@v4
2020-08-17 17:44:06 +00:00
2023-09-25 00:53:50 +00:00
- name: Set up JDK 17
2022-04-22 02:44:03 +00:00
uses: actions/setup-java@v3
2020-08-17 17:44:06 +00:00
with:
2023-06-01 15:20:03 +00:00
java-version: '17'
distribution: 'temurin'
2020-08-17 17:44:06 +00:00
- name: Setup Android SDK
2023-09-25 01:30:57 +00:00
uses: android-actions/setup-android@v3
2020-08-17 17:44:06 +00:00
- name: Build SampleApplication
run: ./gradlew --no-daemon build
```
2023-11-21 20:41:46 +00:00
## Additional packages
2023-11-25 15:41:26 +00:00
Input parameter `packages` controls which packages this action will install from Android SDK.
Default value is `tools platform-tools` , supply an empty string to skip installing additional packages.
Additional packages can be installed at a later time by calling sdkmanager manually.
2023-11-21 20:41:46 +00:00
```yaml
- name: Setup Android SDK
uses: android-actions/setup-android@v3
2023-11-25 15:41:26 +00:00
with:
packages: ''
# ...
2023-11-21 20:41:46 +00:00
2023-11-25 15:41:26 +00:00
- run: sdkmanager tools platform-tools
2023-11-21 20:41:46 +00:00
```
2023-11-21 19:18:33 +00:00
## SDK Version selection
Command line tools are versioned using two variables - short and long.
Long one is the build number, used in the zip URL, short one is the human friendly version name.
2024-11-09 21:40:34 +00:00
By default, setup-android installs version 12266719 (short version 16.0).
2023-11-21 19:18:33 +00:00
To install a different version, call setup-android with desired long version as the input parameter `cmdline-tools-version` :
```yaml
- name: Setup Android SDK
uses: android-actions/setup-android@v3
with:
cmdline-tools-version: 8512546
```
#### Version table
| Short version | Long version |
2024-10-29 19:11:09 +00:00
|---------------| --- |
| 16.0 | 12266719 |
| 13.0 | 11479570 |
| 12.0 | 11076708 |
| 11.0 | 10406996 |
| 10.0 | 9862592 |
| 9.0 | 9477386 |
| 8.0 | 9123335 |
| 7.0 | 8512546 |
2023-11-21 19:18:33 +00:00
Current cmdline tools version can be found at https://developer.android.com/studio#command-line-tools-only
2020-01-03 20:38:11 +00:00
2023-11-21 20:08:54 +00:00
2023-11-21 20:35:25 +00:00
# Android SDK Licenses
2023-11-21 20:08:54 +00:00
2023-11-25 15:22:28 +00:00
Android SDK is not public domain software, it comes with a license.
2023-11-21 20:08:54 +00:00
2023-11-21 20:35:25 +00:00
Input parameter `accept-android-sdk-licenses` decides if Android SDK licenses should be agreed to on behalf of the user of this action.
Default option is 'yes', because otherwise SDK is unusable until said licenses are agreed to.
2023-11-21 20:08:54 +00:00
2023-11-21 20:35:25 +00:00
licenses are quite long, to prevent a wall of text in the action output, licenses can be agreed to silently.
Input parameter `log-accepted-android-sdk-licenses` controls whether license texts should be printed or omitted from the text output. Defaults to 'true'.
2023-11-21 20:08:54 +00:00
2020-07-14 15:41:00 +00:00
# Thanks
Based on the project [android-problem-matchers-action ](https://github.com/jonasb/android-problem-matchers-action ) from [@jonasb ](https://github.com/jonasb )
