Skip to content

Commit 90492b1

Browse files
docs: add v11/v12 migration guides and version guidance
1 parent c89802c commit 90492b1

4 files changed

Lines changed: 61 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@ Unleash is a private, secure, and scalable [feature management platform](http
88

99
You can use this client with [Unleash Enterprise](https://www.getunleash.io/pricing?utm_source=readme&utm_medium=java) or [Unleash Open Source](https://github.com/Unleash/unleash).
1010

11-
> **Migrating to v10**
11+
> **Migration guides**
1212
>
13-
> If you're using `MoreOperations`, custom or fallback strategies, subscribers or bootstrapping, please see the full [migration guide](v10_MIGRATION_GUIDE.md) for details. If you use GraalVM or Quarkus, please hold off on upgrading to v10, support is planned but not implemented.
13+
> - [Migrating to v10](v10_MIGRATION_GUIDE.md)
14+
> - [Migrating to v11](v11_MIGRATION_GUIDE.md)
15+
> - [Migrating to v12](v12_MIGRATION_GUIDE.md)
16+
>
17+
> For ongoing updates, prefer v12. The latest patch releases of v10, v11, and v12 are currently aligned on the same optimized implementation path.
1418
1519
## Java Version Compatibility
1620

v10_MIGRATION_GUIDE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This guide highlights the key changes you need to be aware of when upgrading to v10.0.0 of the Unleash client.
44

5+
## Version guidance
6+
7+
For ongoing updates, prefer v12.
8+
9+
The latest patch releases in v10, v11, and v12 are currently aligned on the same optimized
10+
implementation path.
11+
12+
Early v11 introduced a WASM-engine direction that we later reverted in v11 patch releases.
13+
14+
If you need to stay on a specific major version, make sure you run the latest patch in that major.
15+
516
## Custom bootstrapping
617

718
The Bootstrapping interface now requires an `Optional<String>` to be returned rather than a `String`. If the bootstrapper fails to load the feature set, return an `Optional` of empty.

v11_MIGRATION_GUIDE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Migrating to Unleash-Client-Java 11.x
2+
3+
This guide highlights what to know when upgrading from v10 to v11.
4+
5+
## Java runtime requirement
6+
7+
v11 requires Java 11+.
8+
9+
## Migration path
10+
11+
For API-level migration details, refer to the v10 guide:
12+
[v10_MIGRATION_GUIDE.md](v10_MIGRATION_GUIDE.md)
13+
14+
The latest patch releases in v10, v11, and v12 are currently aligned on the same optimized
15+
implementation path.
16+
17+
Early v11 introduced a WASM-engine direction that we later reverted in v11 patch releases.
18+
19+
## Recommendation
20+
21+
v11 is maintained for stability and critical fixes when needed, but for ongoing updates and new
22+
improvements, prefer v12.

v12_MIGRATION_GUIDE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Migrating to Unleash-Client-Java 12.x
2+
3+
This guide highlights what to know when upgrading from v11 to v12.
4+
5+
## Java runtime requirement
6+
7+
v12 requires Java 11+.
8+
9+
## Migration path
10+
11+
For API-level migration details that still apply, refer to the v10 guide:
12+
[v10_MIGRATION_GUIDE.md](v10_MIGRATION_GUIDE.md)
13+
14+
For current guidance on the v11 line, refer to:
15+
[v11_MIGRATION_GUIDE.md](v11_MIGRATION_GUIDE.md)
16+
17+
The latest patch releases in v10, v11, and v12 are currently aligned on the same optimized
18+
implementation path.
19+
20+
## Recommendation
21+
22+
Use v12 for ongoing updates and future improvements.

0 commit comments

Comments
 (0)