doc: Updated the Readme file and created an initial migration guide for V4#905
Open
pmathew92 wants to merge 4 commits intov4_developmentfrom
Open
doc: Updated the Readme file and created an initial migration guide for V4#905pmathew92 wants to merge 4 commits intov4_developmentfrom
pmathew92 wants to merge 4 commits intov4_developmentfrom
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
3 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
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