Skip to content

Commit 592ac41

Browse files
committed
doc: updated the readme and created a new placeholder migration guide for v4
1 parent ca5559f commit 592ac41

File tree

2 files changed

+75
-5
lines changed

2 files changed

+75
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,21 @@
2626

2727
### Requirements
2828

29-
Android API version 31 or later and Java 8+.
29+
Android API version 31 or later and Java 17+.
3030

3131
> :warning: Applications targeting Android SDK version 30 (`targetSdkVersion = 30`) and below should use version 2.9.0.
3232
33-
Heres what you need in `build.gradle` to target Java 8 byte code for Android and Kotlin plugins respectively.
33+
Here's what you need in `build.gradle` to target Java 17 byte code for Android and Kotlin plugins respectively.
3434

3535
```groovy
3636
android {
3737
compileOptions {
38-
sourceCompatibility JavaVersion.VERSION_1_8
39-
targetCompatibility JavaVersion.VERSION_1_8
38+
sourceCompatibility JavaVersion.VERSION_17
39+
targetCompatibility JavaVersion.VERSION_17
4040
}
4141
4242
kotlinOptions {
43-
jvmTarget = '1.8'
43+
jvmTarget = '17'
4444
}
4545
}
4646
```

V4_MIGRATION_GUIDE.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Migration Guide from SDK v3 to v4
2+
3+
## Overview
4+
5+
v4 of the Auth0 Android SDK includes significant build toolchain updates to support the latest Android development environment. This guide documents the changes required when migrating from v3 to v4.
6+
7+
## Requirements Changes
8+
9+
### Java Version
10+
11+
v4 requires **Java 17** or later (previously Java 11).
12+
13+
Update your `build.gradle` to target Java 17:
14+
15+
```groovy
16+
android {
17+
compileOptions {
18+
sourceCompatibility JavaVersion.VERSION_17
19+
targetCompatibility JavaVersion.VERSION_17
20+
}
21+
22+
kotlinOptions {
23+
jvmTarget = '17'
24+
}
25+
}
26+
```
27+
28+
### Gradle and Android Gradle Plugin
29+
30+
v4 requires:
31+
32+
- **Gradle**: 8.10.2 or later
33+
- **Android Gradle Plugin (AGP)**: 8.8.2 or later
34+
35+
Update your `gradle/wrapper/gradle-wrapper.properties`:
36+
37+
```properties
38+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-all.zip
39+
```
40+
41+
Update your root `build.gradle`:
42+
43+
```groovy
44+
buildscript {
45+
dependencies {
46+
classpath 'com.android.tools.build:gradle:8.8.2'
47+
}
48+
}
49+
```
50+
51+
### Kotlin Version
52+
53+
v4 uses **Kotlin 2.0.21** . If you're using Kotlin in your project, you may need to update your Kotlin version to ensure compatibility.
54+
55+
```groovy
56+
buildscript {
57+
ext.kotlin_version = "2.0.21"
58+
}
59+
```
60+
61+
## Breaking Changes
62+
63+
64+
## Getting Help
65+
66+
If you encounter issues during migration:
67+
68+
- [GitHub Issues](https://github.com/auth0/Auth0.Android/issues) - Report bugs or ask questions
69+
- [Auth0 Community](https://community.auth0.com/) - Community support
70+
- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples

0 commit comments

Comments
 (0)