Skip to content

docs: align README install versions with the 5.2.0 release - #353

Merged
devondragon merged 1 commit into
mainfrom
docs/align-readme-5.2.0
Aug 12, 2026
Merged

docs: align README install versions with the 5.2.0 release#353
devondragon merged 1 commit into
mainfrom
docs/align-readme-5.2.0

Conversation

@devondragon

Copy link
Copy Markdown
Owner

5.2.0 is published to Maven Central and the GitHub release is up, but the README still pointed users at 5.1.1.

Changes

  • Compatibility matrix: the Spring Boot 4.0.x–4.1.x row now reads 5.2.x (was 5.1.x).
  • Install snippets: Maven <version> and the Gradle implementation line in the Spring Boot 4.x section, plus the Quick Start snippet, now use 5.2.0 (was 5.1.1).
  • Versioning note: the line "built and verified against Spring Boot 4.1.0" now names 5.2.x.
  • Spring Boot 3.5 maintenance note: points readers at 5.2.x as the active line for new feature development, and generalizes the backport source to "the 5.x line".

Deliberately unchanged

  • The 4.4.x5.0.x breaking-release sentence and the MIGRATION.md "Migrating to 5.0.x" anchor. Both describe history and a real section heading, not the current line.
  • All 3.6.x references in the Spring Boot 3.5 section — that line is unchanged by this release.

Docs only; no code or build changes.

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.
Copilot AI lite review requested due to automatic review settings August 12, 2026 07:26
@claude

claude Bot commented Aug 12, 2026

Copy link
Copy Markdown

Reviewed — this is a clean, minimal docs-only change.

Correctness

  • Verified no stray 5.1.1 / 5.1.x references remain anywhere in README.md, MIGRATION.md, CONFIG.md, or PROFILE.md after this change — the update is complete and consistent.
  • The deliberately-unchanged items called out in the PR description (4.4.x5.0.x breaking-release sentence, the MIGRATION.md "Migrating to 5.0.x" anchor, and the 3.6.x references) are correctly left alone — they describe historical facts / a real doc anchor, not the current release line, so touching them would have been wrong.
  • gradle.properties currently shows 5.2.1-SNAPSHOT (next dev cycle), while the README now points at 5.2.0 (the published release) — that's the expected/correct relationship, not a discrepancy.

Code quality / process

  • No code or build changes, matches the stated scope.
  • Commit message is clear and explains the "why" (published release vs. stale docs).

No bugs, security concerns, or test coverage gaps apply here since it's a version-string-only README update. LGTM.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates README documentation to reflect the published 5.2.0 release of Spring User Framework for Spring Boot 4.x users, ensuring installation and compatibility guidance matches the current Maven Central/GitHub release state.

Changes:

  • Updated the Spring Boot 4.0.x–4.1.x compatibility matrix entry from 5.1.x to 5.2.x.
  • Updated Maven/Gradle installation snippets (including Quick Start) from 5.1.1 to 5.2.0.
  • Updated versioning/maintenance notes to refer to the active 5.2.x feature-development line and generalized the backport source to the 5.x line.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@devondragon
devondragon merged commit 1480020 into main Aug 12, 2026
5 checks passed
@devondragon
devondragon deleted the docs/align-readme-5.2.0 branch August 12, 2026 07:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants