Skip to content

Commit 617da62

Browse files
authored
[Docs] Add project status/evolution section (#415)
Resolves #412
1 parent fa058f1 commit 617da62

File tree

4 files changed

+32
-2
lines changed

4 files changed

+32
-2
lines changed

README.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Spring Pulsar provides a basic Spring-friendly API for developing https://pulsar
66

77
**#TIP#**: Most of the ideas in this project are borrowed from the Spring for Apache Kafka project, thus a familiarity with it would help.
88

9+
include::spring-pulsar-docs/src/main/asciidoc/project-state.adoc[leveloffset=+1]
10+
911
== Getting Started
1012
The {docs}/html/[reference documentation] includes a {docs}/html/#quick-tourhtml[quick tour] section.
1113

spring-pulsar-docs/src/main/asciidoc/intro.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This project provides a basic Spring-friendly API for developing https://pulsar.
44
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.
55
In addition, it also provides various convenience APIs for Spring developers to ramp up their development journey into Apache Pulsar.
66

7+
include::project-state.adoc[leveloffset=+1]
8+
79
== Supported Versions
810

911
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
3436

3537
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).
3638

39+
Details for other versions and compatibility can be found in the <<version-compatibility.adoc#appendix.version-compatibility,appendix>>.
40+
3741
== Building the Project
3842
If you have cloned the project locally, follow these steps to build the project from the source code.
3943

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
= Project Status
2+
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`.

spring-pulsar-docs/src/main/asciidoc/version-compatibility.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ The following is the compatibility matrix:
2121
| 17+
2222
|===
2323

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.
2427
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.
2729
^**(*)**^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.
30+
====

0 commit comments

Comments
 (0)