Skip to content

feat: add Migration Guide V5#919

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.

Sign up for GitHub

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

Merged
tanya732 merged 2 commits into from
Aug 19, 2026
+117 −373
Merged

feat: add Migration Guide V5 #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4e2a2f
add Migration Guide V5
tanya732 Aug 19, 2026
76c7090
update readme
tanya732 Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .fernignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,8 +10,8 @@ references/

# Examples and Migration Guide from auth0-real
EXAMPLES.md
v3_MIGRATION_GUIDE.md
v4_MIGRATION_GUIDE.md
v5_MIGRATION_GUIDE.md
LICENSE
CHANGELOG.md

Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -182,7 +182,7 @@ See [references/pitfalls.md](references/pitfalls.md) for the full list. Highligh
| `README.md` | Overview, install, getting started (Auth + Management) | yes (hand-maintained) |
| `EXAMPLES.md` | Scenario code samples | yes (hand-maintained) |
| `reference.md` | Management API code samples | no — **generated**, do not hand-edit |
| `v4_MIGRATION_GUIDE.md` / `v3_MIGRATION_GUIDE.md` | Major-version migration | yes (hand-maintained) |
| `v5_MIGRATION_GUIDE.md` / `v4_MIGRATION_GUIDE.md` | Major-version migration | yes (hand-maintained) |
| `CHANGELOG.md` | Release history | yes — release-flow artifact, not edited per-PR |

See [references/docs-update.md](references/docs-update.md) for the full code-to-docs mapping.
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@
>
> While this change won't affect most developers, if you have implemented a dependency signature validation step in your build process, you may notice a warning that past releases can't be verified. This is expected, and a result of the key rotation process. Updating to the latest version will resolve this for you.
>
> We are improving our API specs which introduces minor breaking changes.
> We are improving our API specs which introduces minor breaking changes. Expect major releases more frequently than usual while this work continues. Each one ships with a migration guide, and breaking changes are kept small and mechanical.

![A Java client library for the Auth0 Authentication and Management APIs.](https://cdn.auth0.com/website/sdks/banners/auth0-java-banner.png)

Expand All@@ -20,8 +20,8 @@
## Documentation
- [Reference](./reference.md) - code samples for Management APIs.
- [Examples](./EXAMPLES.md) - code samples for common auth0-java scenarios.
- [v5 Migration Guide](./v5_MIGRATION_GUIDE.md) - guidance for updating your application from version 4 to version 5 of auth0-java.
- [v4 Migration Guide](./v4_MIGRATION_GUIDE.md) - guidance for updating your application from version 3 to version 4 of auth0-java.
- [v3 Migration Guide](./v3_MIGRATION_GUIDE.md) - guidance for updating your application from version 2 to version 3 of auth0-java.
- [Docs site](https://www.auth0.com/docs) - explore our docs site and learn more about Auth0.

## Getting Started
Expand Down
Loading
Loading