doc: updated the readme and created a new placeholder migration guide for v4 by pmathew92 · Pull Request #901 · auth0/Auth0.Android

pmathew92 · 2026-02-03T09:55:19Z

Changes

This PR creates a new V4 migration guide with minimum details and updated the Readme. These are not final and are subjective to change

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

… for v4

Copilot

Pull request overview

This PR creates a placeholder migration guide for v4 of the Auth0 Android SDK and updates the README to reflect the new Java 17 requirement. The changes document the build toolchain updates (Java 17, Gradle 8.10.2, AGP 8.8.2, Kotlin 2.0.21) required for SDK v4, while maintaining a minimal structure that can be expanded as more breaking changes are identified.

Changes:

Created V4_MIGRATION_GUIDE.md documenting requirements changes (Java 17, Gradle 8.10.2, AGP 8.8.2, Kotlin 2.0.21)
Updated README.md to reflect Java 17 requirement with code examples
Added v4_development branch to CI workflow pull request triggers
Refactored GitHub Actions setup to use direct action calls instead of SDK manager

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.

File	Description
V4_MIGRATION_GUIDE.md	New migration guide documenting build toolchain version requirements for v4
README.md	Updated Java version requirement from 8 to 17 in documentation and code examples
.github/workflows/test.yml	Added v4_development branch to pull request triggers
.github/actions/setup/action.yml	Refactored CI setup to use native GitHub actions with explicit version pinning

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-06T12:13:57Z

.github/actions/setup/action.yml

+#    - name: Make gradlew executable
+#      shell: bash
+#      run: chmod +x ./gradlew
+
+    - name: Setup Gradle
+      uses: gradle/actions/setup-gradle@473878a77f1b98e2b5ac4af93489d1656a80a5ed  # v4.2.0
+      with:
+        gradle-version: '8.10'
+        cache: 'gradle'
+
+    - name: Set up Android
+      uses: android-actions/setup-android@9fc6c4e9069bf8d3d10b2204b1fb8f6ef7065407 # v3.2.2

-    - run: ./gradlew androidDependencies
+    - name: Download Android dependencies
+      run: ./gradlew androidDependencies
      shell: bash

-    - uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4 # pin@1.1.0
+#    - name: Validate Gradle wrapper
+#      uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4 # pin@1.1.0


Large blocks of commented-out code reduce maintainability. If these steps (Make gradlew executable and Validate Gradle wrapper) are not needed, they should be removed entirely. If they might be needed in the future, consider documenting why they are commented out.

Copilot · 2026-02-06T12:13:58Z

V4_MIGRATION_GUIDE.md

+
+- [GitHub Issues](https://github.com/auth0/Auth0.Android/issues) - Report bugs or ask questions
+- [Auth0 Community](https://community.auth0.com/) - Community support
+- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples


The repository name casing is inconsistent between lines 68 and 70. Line 68 uses "Auth0.Android" while line 70 uses "auth0.android". While GitHub URLs are case-insensitive, this inconsistency should be fixed for better readability. Based on the pattern in README.md where issues links use "Auth0.Android" (capital letters), both should use "Auth0.Android" for consistency.

Suggested change

- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples

- [Migration Examples](https://github.com/auth0/Auth0.Android/blob/main/EXAMPLES.md) - Updated code examples

Copilot · 2026-02-06T12:13:58Z

.github/actions/setup/action.yml

+#    - name: Validate Gradle wrapper
+#      uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4 # pin@1.1.0


The Gradle wrapper validation action is commented out. This validation is a security best practice that ensures the Gradle wrapper hasn't been tampered with. Unless there's a specific reason to disable it, this should be uncommented to maintain security standards.

Suggested change

# - name: Validate Gradle wrapper

# uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4 # pin@1.1.0

- name: Validate Gradle wrapper

uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4 # pin@1.1.0

Copilot · 2026-02-06T12:13:58Z

V4_MIGRATION_GUIDE.md

+
+### 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.


There is an extra space before the period. The text "Kotlin 2.0.21 ." should be "Kotlin 2.0.21."

Suggested change

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.

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.

Copilot · 2026-02-06T12:13:59Z

.github/actions/setup/action.yml

+    - name: Setup Gradle
+      uses: gradle/actions/setup-gradle@473878a77f1b98e2b5ac4af93489d1656a80a5ed  # v4.2.0
+      with:
+        gradle-version: '8.10'


The Gradle version specified here (8.10) does not match the version specified in the V4_MIGRATION_GUIDE.md (8.10.2) and the actual gradle-wrapper.properties file (8.10.2). This should be '8.10.2' for consistency.

Suggested change

gradle-version: '8.10'

gradle-version: '8.10.2'

Copilot · 2026-02-06T12:13:59Z

.github/actions/setup/action.yml

      with:
        distribution: 'temurin'
        java-version: '17'
+        cache: 'gradle'


The 'cache' parameter is specified twice for Gradle setup: once in the setup-java action (line 13) and once in the setup-gradle action (line 23). The setup-gradle action already handles Gradle caching, so the cache parameter in setup-java is redundant and could potentially cause conflicts. Remove the cache: 'gradle' parameter from the setup-java action.

Suggested change

cache: 'gradle'

Copilot · 2026-02-06T12:13:59Z

V4_MIGRATION_GUIDE.md

+```
+
+## Breaking Changes
+


The "Breaking Changes" section is empty. While the PR description mentions this is not final, consider adding a note here explaining that this section will be populated once breaking changes are identified, to make it clear this is intentionally empty rather than forgotten. For example: "No breaking API changes have been identified in v4. This section will be updated if any are discovered."

Suggested change

No breaking API changes have been identified in v4. This section will be updated if any are discovered.

Copilot · 2026-02-06T12:13:59Z

V4_MIGRATION_GUIDE.md

+
+- [GitHub Issues](https://github.com/auth0/Auth0.Android/issues) - Report bugs or ask questions
+- [Auth0 Community](https://community.auth0.com/) - Community support
+- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples


The link text "Migration Examples" suggests there is a dedicated migration examples section in EXAMPLES.md, but this section does not exist. Either update EXAMPLES.md to include migration-specific examples, or change the link text to something more accurate like "Code Examples" and update the URL to point to a more general section (e.g., the root of EXAMPLES.md).

Suggested change

- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples

- [Code Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples

Copilot · 2026-02-06T12:14:00Z

V4_MIGRATION_GUIDE.md

+
+- [GitHub Issues](https://github.com/auth0/Auth0.Android/issues) - Report bugs or ask questions
+- [Auth0 Community](https://community.auth0.com/) - Community support
+- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples


The link to EXAMPLES.md uses an absolute GitHub URL, but the existing migration guides use relative links for internal documentation. For consistency with V3_MIGRATION_GUIDE.md (line 66), change this to a relative link: [Code Examples](EXAMPLES.md) instead of the full GitHub URL.

…ility The willReturnValidJsonWebKeys() method was using a relative file path (src/test/resources/rsa_jwks.json) which works locally when the working directory is the module folder, but fails in CI where the working directory is the project root. Changed to use classloader.getResourceAsStream() which works regardless of the current working directory. Also improved error handling to actually throw the exception instead of silently ignoring it, which made debugging difficult.

…compatibility" This reverts commit ec23701.

pmathew92 · 2026-02-08T11:23:44Z

Superseded by #905

doc: updated the readme and created a new placeholder migration guide…

592ac41

… for v4

pmathew92 requested a review from a team as a code owner February 3, 2026 09:55

NandanPrabhu previously approved these changes Feb 3, 2026

View reviewed changes

Updated the workflow to run UT for PRs during development

0bfafaa

pmathew92 dismissed NandanPrabhu’s stale review via 0bfafaa February 3, 2026 10:15

NandanPrabhu previously approved these changes Feb 3, 2026

View reviewed changes

updated the setup action file

dd48fc2

pmathew92 dismissed NandanPrabhu’s stale review via dd48fc2 February 3, 2026 10:37

updated the set up action file

23911a9

Copilot AI review requested due to automatic review settings February 6, 2026 12:08

Copilot started reviewing on behalf of pmathew92 February 6, 2026 12:09 View session

Copilot AI reviewed Feb 6, 2026

View reviewed changes

pmathew92 added 12 commits February 6, 2026 18:06

Revert "fix: Use classloader for loading test resources to ensure CI …

f703f0f

…compatibility" This reverts commit ec23701.

Using zulu instead of temurin

7d3ade9

ADding the SDK components in the pipeline

df63bbf

Fixing the failed test

daf3a5e

Checking another fix

63a879b

Another fix trial

5abda8a

Added stacktrace for failure

ce9a43e

Updated the action file

696b2d6

Changed the test appraoch

c9d5896

commenting the failed test cases to check

74ee6c9

Ignoring the failing test

9e83b29

pmathew92 closed this Feb 8, 2026

pmathew92 deleted the doc/migration branch February 8, 2026 11:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: updated the readme and created a new placeholder migration guide for v4#901

doc: updated the readme and created a new placeholder migration guide for v4#901
pmathew92 wants to merge 16 commits intov4_developmentfrom
doc/migration

pmathew92 commented Feb 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

pmathew92 commented Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples
	- [Migration Examples](https://github.com/auth0/Auth0.Android/blob/main/EXAMPLES.md) - Updated code examples

		# - name: Validate Gradle wrapper
		# uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4 # pin@1.1.0 No newline at end of file


		### 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.

	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.
	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.



	No breaking API changes have been identified in v4. This section will be updated if any are discovered.

	- [Migration Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples
	- [Code Examples](https://github.com/auth0/auth0.android/blob/main/EXAMPLES.md) - Updated code examples

Conversation

pmathew92 commented Feb 3, 2026

Changes

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

pmathew92 commented Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants