Skip to content

Commit 812487e

Browse files
bsboddenbsbodden
authored
docs: add Spring Boot version requirements and compatibility policy (#632)
- Document N-2 version support policy in README - Create dedicated version-requirements.adoc page in docs - Add comprehensive version compatibility matrix - Include upgrade guidance and dependency alignment examples - Update quickstart prerequisites with version info Fixes #520
1 parent 53c2212 commit 812487e

File tree

4 files changed

+196
-3
lines changed

4 files changed

+196
-3
lines changed

‎README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,32 @@ This **preview** release provides all Spring Data Redis, plus:
8585
* `@Vectorize` annotation to generate embeddings for text and images for use in Vector Similarity Searches
8686
* Vector Similarity Search API (See [Redis Stack Vectors](https://redis.io/docs/stack/search/reference/vectors/))
8787

88-
**Note:** Redis OM Spring requires Jedis version 5.2.0 or later, as well as Spring Data Redis version 3.4.1 or later, which is built on top of Spring Framework 6.2.+.
88+
### 📋 Version Requirements
89+
90+
Redis OM Spring has the following version requirements:
91+
92+
| Dependency | Minimum Version | Recommended Version | Notes |
93+
|------------|----------------|-------------------|--------|
94+
| **Spring Boot** | 3.3.x | 3.4.x or 3.5.x | Built with Spring Boot 3.4.5 |
95+
| **Spring Data Redis** | 3.4.1 | 3.4.5 or later | Aligned with Spring Boot version |
96+
| **Spring Framework** | 6.2.x | Latest 6.x | Transitive via Spring Boot |
97+
| **Jedis** | 5.2.0 | 5.2.0 or later | Redis Java client |
98+
| **Java** | 17 | 17 or 21 | Spring Boot 3.x requires Java 17+ |
99+
| **Redis Stack** | 6.2.x | 7.2.x or later | For JSON and Search modules |
100+
101+
#### Spring Boot Version Compatibility Policy
102+
103+
Redis OM Spring follows an **N-2 support policy** for Spring Boot versions:
104+
- We build with the latest stable Spring Boot version
105+
- We support the current version and two previous minor versions that are still receiving OSS updates
106+
- We upgrade Spring Boot with each Redis OM Spring release
107+
108+
For example, as of Redis OM Spring 1.0.0-RC3 (July 2025):
109+
- **Built with**: Spring Boot 3.4.5
110+
- **Minimum supported**: Spring Boot 3.3.x
111+
- **Recommended**: Spring Boot 3.4.x or 3.5.x
112+
113+
⚠️ **Note**: Using older Spring Boot versions may work but is not officially tested or supported. For production use, we recommend staying within the supported version range.
89114

90115
## 🏁 Getting Started
91116

‎docs/content/modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
55
.Getting Started
66
* xref:setup.adoc[Installation & Setup]
7+
* xref:version-requirements.adoc[Version Requirements]
78
* xref:configuration.adoc[Configuration]
89
* xref:quickstart.adoc[Quick Start Example]
910

‎docs/content/modules/ROOT/pages/quickstart.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ This quick start guide will walk you through building a Spring Boot application
99

1010
Before you begin, make sure you have:
1111

12-
* Java 17 or higher
13-
* Maven 3.6+
12+
* Java 17 or higher (Spring Boot 3.x requirement)
13+
* Maven 3.6+ or Gradle 7.5+
1414
* Docker (for running Redis)
15+
* Spring Boot 3.3.x or higher (see <<version-requirements>> below)
1516

1617
== Setting Up Redis
1718

‎docs/content/modules/ROOT/pages/version-requirements.adoc

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
= Version Requirements
2+
:page-toclevels: 3
3+
:page-pagination:
4+
:source-highlighter: highlight.js
5+
6+
This page documents the version requirements and compatibility policy for Redis OM Spring.
7+
8+
[[version-requirements]]
9+
== Current Version Requirements
10+
11+
Redis OM Spring has the following version requirements:
12+
13+
[cols="30,20,20,30", options="header"]
14+
|===
15+
|Dependency
16+
|Minimum Version
17+
|Recommended Version
18+
|Notes
19+
20+
|Spring Boot
21+
|3.3.x
22+
|3.4.x or 3.5.x
23+
|Built with Spring Boot 3.4.5
24+
25+
|Spring Data Redis
26+
|3.4.1
27+
|3.4.5 or later
28+
|Aligned with Spring Boot version
29+
30+
|Spring Framework
31+
|6.2.x
32+
|Latest 6.x
33+
|Transitive via Spring Boot
34+
35+
|Jedis
36+
|5.2.0
37+
|5.2.0 or later
38+
|Redis Java client
39+
40+
|Java
41+
|17
42+
|17 or 21
43+
|Spring Boot 3.x requires Java 17+
44+
45+
|Redis Stack
46+
|6.2.x
47+
|7.2.x or later
48+
|For JSON and Search modules
49+
|===
50+
51+
== Spring Boot Version Compatibility Policy
52+
53+
Redis OM Spring follows an **N-2 support policy** for Spring Boot versions:
54+
55+
* We build with the latest stable Spring Boot version
56+
* We support the current version and two previous minor versions that are still receiving OSS updates
57+
* We upgrade Spring Boot with each Redis OM Spring release
58+
59+
=== Example
60+
61+
As of Redis OM Spring 1.0.0-RC3 (July 2025):
62+
63+
* **Built with**: Spring Boot 3.4.5
64+
* **Minimum supported**: Spring Boot 3.3.x (OSS support until June 2025)
65+
* **Recommended**: Spring Boot 3.4.x or 3.5.x
66+
67+
[WARNING]
68+
====
69+
Using older Spring Boot versions may work but is not officially tested or supported. For production use, we recommend staying within the supported version range.
70+
====
71+
72+
== How the Support Policy Works
73+
74+
=== Release Schedule
75+
76+
Spring Boot releases follow a predictable schedule:
77+
78+
* New major or minor versions every 6 months (May and November)
79+
* OSS support for 12 months per minor version
80+
* Commercial support available for extended periods
81+
82+
=== Our Approach
83+
84+
1. **On each Redis OM Spring release**: We update to the latest stable Spring Boot version
85+
2. **Minimum version**: We support versions that are still receiving OSS updates
86+
3. **Testing**: We test against all supported Spring Boot versions in our CI pipeline
87+
88+
=== Determining Supported Versions
89+
90+
To determine which Spring Boot versions Redis OM Spring supports:
91+
92+
1. Check the `springBootVersion` in `gradle.properties` - this is what we build with
93+
2. Check the https://spring.io/projects/spring-boot#support[Spring Boot support timeline]
94+
3. We support the build version and any previous minor versions still receiving OSS updates
95+
96+
== Upgrading Spring Boot
97+
98+
If you need to upgrade your Spring Boot version:
99+
100+
1. Check the https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.x-Release-Notes[Spring Boot release notes] for breaking changes
101+
2. Update your `pom.xml` or `build.gradle` to use the new version
102+
3. Run your tests to ensure compatibility
103+
4. Pay special attention to:
104+
* Spring Data Redis changes
105+
* Spring Framework changes
106+
* Java version requirements
107+
108+
== Java Version Requirements
109+
110+
Redis OM Spring requires Java 17 or higher because:
111+
112+
* Spring Boot 3.x requires Java 17 as a minimum
113+
* We use Java 17 language features in our codebase
114+
* Java 17 is an LTS (Long Term Support) release
115+
116+
We recommend using Java 17 or Java 21 (the next LTS) for production deployments.
117+
118+
== Redis Requirements
119+
120+
Redis OM Spring requires Redis Stack or Redis with specific modules:
121+
122+
* **Minimum Redis version**: 6.2.x
123+
* **Recommended**: Redis Stack 7.2.x or later
124+
* **Required modules**:
125+
** RedisJSON for document storage
126+
** RediSearch for indexing and querying
127+
128+
You can run Redis Stack using Docker:
129+
130+
[source,bash]
131+
----
132+
docker run -p 6379:6379 redis/redis-stack:latest
133+
----
134+
135+
Or Redis 8.0+ which includes these capabilities:
136+
137+
[source,bash]
138+
----
139+
docker run -p 6379:6379 redis:8.0.0
140+
----
141+
142+
== Dependency Version Alignment
143+
144+
When using Redis OM Spring, ensure your dependencies are aligned:
145+
146+
[source,xml]
147+
----
148+
<properties>
149+
<spring-boot.version>3.4.5</spring-boot.version>
150+
<redis-om-spring.version>1.0.0-RC3</redis-om-spring.version>
151+
</properties>
152+
153+
<dependencies>
154+
<dependency>
155+
<groupId>com.redis.om</groupId>
156+
<artifactId>redis-om-spring</artifactId>
157+
<version>${redis-om-spring.version}</version>
158+
</dependency>
159+
<!-- Spring Boot dependencies will be managed by the parent POM -->
160+
</dependencies>
161+
----
162+
163+
[TIP]
164+
====
165+
Use Spring Boot's dependency management to ensure all Spring-related dependencies are aligned with your Spring Boot version.
166+
====

0 commit comments

Comments
 (0)