-
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
Open
pmathew92
wants to merge
4
commits into
v4_development
Choose a base branch
from
migration_doc
base: v4_development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+88
−9
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d02e158
doc: Updated the Readme file and created an initial migration guide f…
pmathew92 3c2d14d
Commneted out the failing test cases in GH CI pipeline till the depen…
pmathew92 84454b6
Annotated the failing test with Ignore
pmathew92 a824bd3
nit: Minor changes based on review comment
pmathew92 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ on: | |
| pull_request: | ||
| branches: | ||
| - main | ||
| - v4_development | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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+). | ||
|
|
||
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.