Skip to content

Commit b4e2a2f

Browse files
committed
add Migration Guide V5
1 parent b385363 commit b4e2a2f

5 files changed

Lines changed: 119 additions & 375 deletions

File tree

.fernignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ references/
1010

1111
# Examples and Migration Guide from auth0-real
1212
EXAMPLES.md
13-
v3_MIGRATION_GUIDE.md
1413
v4_MIGRATION_GUIDE.md
14+
v5_MIGRATION_GUIDE.md
1515
LICENSE
1616
CHANGELOG.md
1717

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ See [references/pitfalls.md](references/pitfalls.md) for the full list. Highligh
182182
| `README.md` | Overview, install, getting started (Auth + Management) | yes (hand-maintained) |
183183
| `EXAMPLES.md` | Scenario code samples | yes (hand-maintained) |
184184
| `reference.md` | Management API code samples | no — **generated**, do not hand-edit |
185-
| `v4_MIGRATION_GUIDE.md` / `v3_MIGRATION_GUIDE.md` | Major-version migration | yes (hand-maintained) |
185+
| `v5_MIGRATION_GUIDE.md` / `v4_MIGRATION_GUIDE.md` | Major-version migration | yes (hand-maintained) |
186186
| `CHANGELOG.md` | Release history | yes — release-flow artifact, not edited per-PR |
187187

188188
See [references/docs-update.md](references/docs-update.md) for the full code-to-docs mapping.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
>
44
> 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.
55
>
6-
> We are improving our API specs which introduces minor breaking changes.
6+
> 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.
77
88
![A Java client library for the Auth0 Authentication and Management APIs.](https://cdn.auth0.com/website/sdks/banners/auth0-java-banner.png)
99

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

2727
## Getting Started
@@ -40,14 +40,14 @@ Add the dependency via Maven:
4040
<dependency>
4141
<groupId>com.auth0</groupId>
4242
<artifactId>auth0</artifactId>
43-
<version>4.2.0</version>
43+
<version>5.0.0</version>
4444
</dependency>
4545
```
4646

4747
or Gradle:
4848

4949
```gradle
50-
implementation 'com.auth0:auth0:4.2.0'
50+
implementation 'com.auth0:auth0:5.0.0'
5151
```
5252

5353
### Configure the SDK

0 commit comments

Comments
 (0)