You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spring-pulsar-docs/src/main/asciidoc/intro.adoc
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@ This project provides a basic Spring-friendly API for developing https://pulsar.
4
4
On a very high level, Spring for Apache Pulsar provides a `PulsarTemplate` for publishing to a Pulsar topic and a `PulsarListener` annotation for consuming from a Pulsar topic.
5
5
In addition, it also provides various convenience APIs for Spring developers to ramp up their development journey into Apache Pulsar.
6
6
7
+
include::project-state.adoc[leveloffset=+1]
8
+
7
9
== Supported Versions
8
10
9
11
The supported versions for the underlying libraries required by the framework are as follows:
@@ -34,6 +36,8 @@ The supported versions for the underlying libraries required by the framework ar
34
36
35
37
NOTE: The **Version Used** is the version of the library targeted by Spring Pulsar {spring-pulsar-version} (the version of the framework this reference guide belongs to).
36
38
39
+
Details for other versions and compatibility can be found in the <<version-compatibility.adoc#appendix.version-compatibility,appendix>>.
40
+
37
41
== Building the Project
38
42
If you have cloned the project locally, follow these steps to build the project from the source code.
While the code and functionality of the framework is thoroughly tested and ready for production, the project is in a bit of flux while transitioning from experimental GA (`0.2.x`) to GA (`1.0.0`).
3
+
4
+
The evolution of the project (by version) is as follows:
5
+
6
+
== Version 0.2.x
7
+
All components (`the core + Spring Boot autoconfiguration + Spring Cloud Stream binder`) reside in the `spring-pulsar` Github repository.
8
+
9
+
This is considered an "experimental" GA, defined as:
10
+
11
+
- code and functionality is production ready, but decision has not been made to support the project permanently
12
+
- available on Maven Central using a major version of `0` to indicate its nature
13
+
14
+
== Version 1.0.x
15
+
This is the "full" GA and the components are split as follows (in-progress):
16
+
17
+
- the core stays in the `spring-pulsar` repo (`main` branch)
18
+
- the autoconfiguration moves to the Spring Boot project (targeting Spring Boot `3.2.0`)
19
+
- the binder moves to the Spring Cloud Stream project (targeting SCSt `4.1.0`)
20
+
21
+
NOTE: Until the GA release, the recommended version of the framework is `0.2.x`.
Copy file name to clipboardExpand all lines: spring-pulsar-docs/src/main/asciidoc/version-compatibility.adoc
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,10 @@ The following is the compatibility matrix:
21
21
| 17+
22
22
|===
23
23
24
+
[NOTE]
25
+
====
26
+
In version `1.0.0` the auto-configuration moved into Spring Boot `3.2.x` and therefore `3.2.x` is the minimum Spring Boot version supported when using version `1.0.x` of the framework.
24
27
25
-
NOTE: In version `1.0.0` the auto-configuration moved into Spring Boot `3.2.x` and therefore `3.2.x` is the minimum Spring Boot version supported when using version `1.0.x` of the framework.
26
-
Prior to version `1.0.0`, the auto-configuration support exists in the framework itself.
28
+
However, prior to version `1.0.0`, the auto-configuration support exists in the framework itself.
27
29
^**(*)**^This makes it theoretically possible to use later versions of Spring Boot besides `3.0.x` which it is tested against and guaranteed to work with. In other words, it may work with `3.1.x` but it has not been tested against it.
0 commit comments