doc: Updated the Readme file and created an initial migration guide for V4 #905
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates documentation for the upcoming v4 toolchain requirements and adds an initial v3→v4 migration guide, alongside a small CI workflow tweak and temporarily disabled unit tests.
Changes:
- Updated README to reflect Java 17 requirements and v4 dependency/version examples.
- Added
V4_MIGRATION_GUIDE.mddescribing Java/Gradle/AGP/Kotlin requirements for v4. - Adjusted CI workflow to run on PRs targeting
v4_development, and commented out two failing Robolectric-related tests.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.kt | Comments out two unit tests with a TODO referencing a CI/dependency issue. |
| V4_MIGRATION_GUIDE.md | New migration guide documenting v4 build toolchain requirements. |
| README.md | Updates stated requirements and installation snippet for v4 + Java 17 examples. |
| .github/workflows/test.yml | Adds v4_development as an allowed PR base branch for CI runs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.kt
Outdated
Show resolved
Hide resolved
auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.kt
Outdated
Show resolved
Hide resolved
auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.kt
Outdated
Show resolved
Hide resolved
auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.kt
Outdated
Show resolved
Hide resolved
auth0/src/test/java/com/auth0/android/provider/WebAuthProviderTest.kt
Outdated
Show resolved
Hide resolved
| ```gradle | ||
| dependencies { | ||
| implementation 'com.auth0.android:auth0:3.12.2' | ||
| implementation 'com.auth0.android:auth0:<latest-version>' |
There was a problem hiding this comment.
is this a placeholder ? is latest version defined somewhere?
There was a problem hiding this comment.
This is a placeholder for now
|
|
||
| ### Java Version | ||
|
|
||
| v4 requires **Java 17** or later (previously Java 8+). |
There was a problem hiding this comment.
previously it was Java_11
There was a problem hiding this comment.
Current read me and everything has java 8 . So kept it to keep consistent.
| applicationId "com.auth0.samples" | ||
| minSdkVersion 21 | ||
| targetSdkVersion 30 | ||
| minSdkVersion 24 |
There was a problem hiding this comment.
Are we dropping support for min sdk version from 21 to 23?
There was a problem hiding this comment.
This is the sample app. Need to test if the changes will work on 21 or not
https://github.com/auth0/Auth0.Android?tab=readme-ov-file#requirements
Current V3 has already marked the min as 31
utkrishtsahu
left a comment
utkrishtsahu
left a comment
There was a problem hiding this comment.
LGTM will add more as the V4 implement progress.
3 participants
Changes
This PR updates the Readme file with the new java and other updated SDK dependencies along with creating an initial migration guide for V4
Checklist
I have read the Auth0 general contribution guidelines
I have read the Auth0 Code of Conduct
All existing and new tests complete without errors