From 759707bc95f78ebda570be737d0203b4f96786b6 Mon Sep 17 00:00:00 2001 From: Devon Hillard Date: Wed, 12 Aug 2026 01:26:09 -0600 Subject: [PATCH] docs: align README install versions with the 5.2.0 release The 5.2.0 release is published to Maven Central, but the README still directed users to 5.1.1 and described the 5.1.x family. - Compatibility matrix: 5.1.x -> 5.2.x for the Spring Boot 4.0/4.1 row - Maven/Gradle install snippets and the Quick Start snippet: 5.1.1 -> 5.2.0 - Versioning note: the current line built and verified against Spring Boot 4.1.0 is 5.2.x - Spring Boot 3.5 maintenance note: point readers at 5.2.x as the active line for new development References to the 4.4.x -> 5.0.x breaking jump and the "Migrating to 5.0.x" guide anchor are left alone; those describe history, not the current line. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fca95e2..39d0973 100644 --- a/README.md +++ b/README.md @@ -121,10 +121,10 @@ Choose the version that matches your Spring Boot version: | Spring Boot Version | Framework Version | Java Version | Spring Security | | ------------------- | ----------------- | ------------ | --------------- | -| 4.0.x – 4.1.x | 5.1.x | 21+ | 7.x | +| 4.0.x – 4.1.x | 5.2.x | 21+ | 7.x | | 3.5.x | 3.6.x | 17+ | 6.x | -> **Versioning note:** This library follows Semantic Versioning for its **own** API; its major version is intentionally **not** aligned with Spring Boot's major version. The 5.0.x line is built and verified against **Spring Boot 4.1.0** and also runs on 4.0.x — all Spring Boot starters are `compileOnly`, so your application picks the exact Spring Boot patch version. The `5.0.x` line is a **breaking release** over `4.4.x`; read the **[Migration Guide](MIGRATION.md)** ("Migrating to 5.0.x") before upgrading — note especially the reverse-proxy `user.security.appUrl` requirement. +> **Versioning note:** This library follows Semantic Versioning for its **own** API; its major version is intentionally **not** aligned with Spring Boot's major version. The 5.2.x line is built and verified against **Spring Boot 4.1.0** and also runs on 4.0.x — all Spring Boot starters are `compileOnly`, so your application picks the exact Spring Boot patch version. The `5.0.x` line is a **breaking release** over `4.4.x`; read the **[Migration Guide](MIGRATION.md)** ("Migrating to 5.0.x") before upgrading — note especially the reverse-proxy `user.security.appUrl` requirement. ### Spring Boot 4.x (Latest) @@ -135,13 +135,13 @@ Spring Boot 4.x brings significant changes including Spring Security 7 and requi com.digitalsanctuary ds-spring-user-framework - 5.1.1 + 5.2.0 ``` **Gradle:** ```groovy -implementation 'com.digitalsanctuary:ds-spring-user-framework:5.1.1' +implementation 'com.digitalsanctuary:ds-spring-user-framework:5.2.0' ``` #### Spring Boot 4.x Key Changes @@ -171,7 +171,7 @@ testImplementation 'org.springframework.boot:spring-boot-starter-security-test' For projects using Spring Boot 3.5.x with Java 17+: -> **Security-maintenance only.** The `3.6.x` line backports security fixes from the 5.0.x line that apply to Spring Boot 3.5; new feature development happens on `5.0.x`. If you are on Java 21 / Spring Boot 4, use `5.0.x`. +> **Security-maintenance only.** The `3.6.x` line backports security fixes from the 5.x line that apply to Spring Boot 3.5; new feature development happens on `5.2.x`. If you are on Java 21 / Spring Boot 4, use `5.2.x`. **Maven:** ```xml @@ -214,7 +214,7 @@ Follow these steps to get up and running with the Spring User Framework in your **Spring Boot 4.0 / 4.1 (Java 21+):** ```groovy - implementation 'com.digitalsanctuary:ds-spring-user-framework:5.1.1' + implementation 'com.digitalsanctuary:ds-spring-user-framework:5.2.0' ``` **Spring Boot 3.5 (Java 17+):**