Skip to content

Commit a1a75a8

Browse files
authored
chore: android docs (#290)
1 parent c54d971 commit a1a75a8

File tree

4 files changed

+52
-7
lines changed

4 files changed

+52
-7
lines changed

.github/workflows/continuous-integration.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ on:
55
branches: [ main ]
66
pull_request:
77
branches: [ main ]
8-
paths-ignore:
9-
- 'docs/**'
10-
- '*.md'
118
workflow_dispatch:
129

1310
env:

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,5 @@ Please refer to our [security policy](https://github.com/awslabs/aws-sdk-kotlin/
140140

141141
The SDK supports the following targets:
142142

143-
* JVM
144-
* Android API level 16+ (Later versions of the Android may contain security
145-
fixes so consider reviewing known vulnerabilities for the Android versions
146-
you choose to support in your application.)
143+
* [JVM](docs/targets.md#jvm)
144+
* [Android](docs/targets.md#android)

docs/GettingStarted.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,4 @@ Consult the [stability guide](stability.md) for more information on SDK stabilit
6060
* [Additional examples](https://github.com/awslabs/aws-sdk-kotlin/tree/main/examples)
6161
* [Giving feedback and contributing](https://github.com/awslabs/aws-sdk-kotlin#feedback)
6262
* [Debugging](debugging.md)
63+
* [Android support](targets.md#android)

docs/targets.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Supported Targets
2+
3+
## JVM
4+
5+
The AWS SDK for Kotlin supports running on JDK8+ on the following platforms and architectures:
6+
7+
* Windows: `x86_32`, `x86_64`
8+
* Linux: `x86_32`, `x86_64`, `armv6`, `armv7`, `armv8`
9+
* macOS: `x86_64`
10+
11+
If there is a platform or architecture not supported please submit an issue with details about your use case.
12+
13+
## Android
14+
15+
The AWS SDK for Kotlin supports Android API 24+ (`minSdk = 24`).
16+
17+
NOTE: Later versions of Android may contain security fixes so consider reviewing known vulnerabilities
18+
for the Android versions you choose to support in your application.
19+
20+
Additional requirements:
21+
22+
* Enable [core library desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring)
23+
* Exclude `xmlpull` module
24+
25+
Example config fragments:
26+
27+
```kotlin
28+
// build.gradle.kts
29+
30+
android {
31+
compileOptions {
32+
sourceCompatibility = JavaVersion.VERSION_1_8
33+
targetCompatibility = JavaVersion.VERSION_1_8
34+
isCoreLibraryDesugaringEnabled = true
35+
}
36+
kotlinOptions {
37+
jvmTarget = "1.8"
38+
}
39+
}
40+
41+
// get around a build issue with xmlpull as a dependency
42+
configurations.all {
43+
exclude(group = "xmlpull", module = "xmlpull")
44+
}
45+
46+
dependencies {
47+
coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:1.1.5")
48+
}
49+
```

0 commit comments

Comments
 (0)