-
Notifications
You must be signed in to change notification settings - Fork 167
doc: Updated the Readme file and created an initial migration guide for V4 #905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
d02e158
3c2d14d
84454b6
a824bd3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ on: | |
| pull_request: | ||
| branches: | ||
| - main | ||
| - v4_development | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,21 +26,21 @@ | |
|
|
||
| ### Requirements | ||
|
|
||
| Android API version 31 or later and Java 8+. | ||
| Android API version 31 or later and Java 17+. | ||
|
|
||
| > :warning: Applications targeting Android SDK version 30 (`targetSdkVersion = 30`) and below should use version 2.9.0. | ||
| Here’s what you need in `build.gradle` to target Java 8 byte code for Android and Kotlin plugins respectively. | ||
| Here’s what you need in `build.gradle` to target Java 17 bytecode for Android and Kotlin plugins respectively. | ||
|
|
||
| ```groovy | ||
| android { | ||
| compileOptions { | ||
| sourceCompatibility JavaVersion.VERSION_1_8 | ||
| targetCompatibility JavaVersion.VERSION_1_8 | ||
| sourceCompatibility JavaVersion.VERSION_17 | ||
| targetCompatibility JavaVersion.VERSION_17 | ||
| } | ||
| kotlinOptions { | ||
| jvmTarget = '1.8' | ||
| jvmTarget = '17' | ||
| } | ||
| } | ||
| ``` | ||
|
|
@@ -52,7 +52,7 @@ To install Auth0.Android with [Gradle](https://gradle.org/), simply add the foll | |
|
|
||
| ```gradle | ||
| dependencies { | ||
| implementation 'com.auth0.android:auth0:3.12.2' | ||
| implementation 'com.auth0.android:auth0:<latest-version>' | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is this a placeholder ? is latest version defined somewhere?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a placeholder for now |
||
| } | ||
| ``` | ||
|
|
||
|
|
@@ -117,11 +117,11 @@ Next, define the Manifest Placeholders for the Auth0 Domain and Scheme which are | |
| apply plugin: 'com.android.application' | ||
| android { | ||
| compileSdkVersion 30 | ||
| compileSdkVersion 35 | ||
| defaultConfig { | ||
| applicationId "com.auth0.samples" | ||
| minSdkVersion 21 | ||
| targetSdkVersion 30 | ||
| minSdkVersion 24 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we dropping support for min sdk version from 21 to 23?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the sample app. Need to test if the changes will work on 21 or not |
||
| targetSdkVersion 35 | ||
| //... | ||
| //---> Add the next line | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # Migration Guide from SDK v3 to v4 | ||
|
|
||
| ## Overview | ||
|
|
||
| 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. | ||
|
|
||
| ## Requirements Changes | ||
|
|
||
| ### Java Version | ||
|
|
||
| v4 requires **Java 17** or later (previously Java 8+). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. previously it was Java_11
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Current read me and everything has java 8 . So kept it to keep consistent. |
||
|
|
||
| Update your `build.gradle` to target Java 17: | ||
|
|
||
| ```groovy | ||
| android { | ||
| compileOptions { | ||
| sourceCompatibility JavaVersion.VERSION_17 | ||
| targetCompatibility JavaVersion.VERSION_17 | ||
| } | ||
|
|
||
| kotlinOptions { | ||
| jvmTarget = '17' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Gradle and Android Gradle Plugin | ||
|
|
||
| v4 requires: | ||
|
|
||
| - **Gradle**: 8.10.2 or later | ||
| - **Android Gradle Plugin (AGP)**: 8.8.2 or later | ||
|
|
||
| Update your `gradle/wrapper/gradle-wrapper.properties`: | ||
|
|
||
| ```properties | ||
| distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-all.zip | ||
| ``` | ||
|
|
||
| Update your root `build.gradle`: | ||
|
|
||
| ```groovy | ||
| buildscript { | ||
| dependencies { | ||
| classpath 'com.android.tools.build:gradle:8.8.2' | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Kotlin Version | ||
|
|
||
| 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. | ||
|
|
||
| ```groovy | ||
| buildscript { | ||
| ext.kotlin_version = "2.0.21" | ||
| } | ||
| ``` | ||
|
|
||
| ## Breaking Changes | ||
|
|
||
| No breaking API changes have been identified in v4. This section will be updated if any are discovered. | ||
|
|
||
|
|
||
| ## Getting Help | ||
|
|
||
| If you encounter issues during migration: | ||
|
|
||
| - [GitHub Issues](https://github.com/auth0/Auth0.Android/issues) - Report bugs or ask questions | ||
| - [Auth0 Community](https://community.auth0.com/) - Community support | ||
Uh oh!
There was an error while loading. Please reload this page.