diff --git a/spring-pulsar-docs/spring-pulsar-docs.gradle b/spring-pulsar-docs/spring-pulsar-docs.gradle index 79007ef5..54c624da 100644 --- a/spring-pulsar-docs/spring-pulsar-docs.gradle +++ b/spring-pulsar-docs/spring-pulsar-docs.gradle @@ -86,10 +86,13 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) { } doFirst { attributes "spring-boot-version": project.springBootVersion ?: 'current', + "spring-framework-version": project.springFrameworkVersion ?: 'current', "spring-cloud-stream-version": project.springCloudStreamVersion ?: 'current', "spring-pulsar-version": project.version, "spring-pulsar-binder-version": project.springPulsarBinderVersion ?: 'current', - "spring-pulsar-starter-version": project.springPulsarStarterVersion ?: 'current' + "spring-pulsar-starter-version": project.springPulsarStarterVersion ?: 'current', + "pulsar-client-version": project.pulsarClientVersion ?: 'current', + "pulsar-client-reactive-version": project.pulsarClientReactiveVersion ?: 'current' } } diff --git a/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc b/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc index 19bbd7ae..b90cce43 100644 --- a/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc +++ b/spring-pulsar-docs/src/main/asciidoc/attributes-variables.adoc @@ -1,8 +1,11 @@ :spring-boot-version: current +:spring-framework-version: current :spring-cloud-stream-version: current :spring-pulsar-version: current :spring-pulsar-binder-version: current :spring-pulsar-starter-version: current +:pulsar-client-version: current +:pulsar-client-reactive-version: current :github: https://github.com/spring-projects/spring-pulsar :javadocs: https://docs.spring.io/spring-pulsar/docs/{spring-pulsar-version}/api diff --git a/spring-pulsar-docs/src/main/asciidoc/index.adoc b/spring-pulsar-docs/src/main/asciidoc/index.adoc index 9c5795dd..868f2275 100644 --- a/spring-pulsar-docs/src/main/asciidoc/index.adoc +++ b/spring-pulsar-docs/src/main/asciidoc/index.adoc @@ -42,6 +42,8 @@ In addition to this reference documentation, we recommend a number of other reso [[appendix]] == Appendices +include::version-compatibility.adoc[leveloffset=+2] + include::non-ga-versions.adoc[leveloffset=+2] include::native-image.adoc[leveloffset=+2] diff --git a/spring-pulsar-docs/src/main/asciidoc/intro.adoc b/spring-pulsar-docs/src/main/asciidoc/intro.adoc index 0c777a92..62981dbd 100644 --- a/spring-pulsar-docs/src/main/asciidoc/intro.adoc +++ b/spring-pulsar-docs/src/main/asciidoc/intro.adoc @@ -4,28 +4,36 @@ This project provides a basic Spring-friendly API for developing https://pulsar. 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. In addition, it also provides various convenience APIs for Spring developers to ramp up their development journey into Apache Pulsar. -== Minimum Supported Versions +== Supported Versions -The minimum supported versions for the underlying libraries required by the framework are as follows: +The supported versions for the underlying libraries required by the framework are as follows: |=== -| Library | Version +| Library | Minimum Version | Version Used + +| Apache Pulsar +| 3.0.0 +| {pulsar-client-version} + +| Spring Framework +| 6.0.9 +| {spring-framework-version} + +| Spring Boot +| 3.2.0 +| {spring-boot-version} | Java | 17 - -| Apache Pulsar -| 2.10.0 - -| Spring Boot -| 3.0.0 - -| Spring Framework -| 6.0.0 +| - | Gradle -| 7.5 +| 7.4 +| - + |=== +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). + == Building the Project If you have cloned the project locally, follow these steps to build the project from the source code. diff --git a/spring-pulsar-docs/src/main/asciidoc/version-compatibility.adoc b/spring-pulsar-docs/src/main/asciidoc/version-compatibility.adoc new file mode 100644 index 00000000..940623e5 --- /dev/null +++ b/spring-pulsar-docs/src/main/asciidoc/version-compatibility.adoc @@ -0,0 +1,27 @@ +[appendix] +[[appendix.version-compatibility]] += Pulsar Clients and Spring Boot Compatibility + +include::attributes.adoc[] + +The following is the compatibility matrix: +|=== +| Spring for Apache Pulsar | Pulsar Client | Pulsar Reactive Client | Spring Boot | Java + +| 1.0.x +| 3.0.x +| 0.3.x +| 3.2.x +| 17+ + +| 0.2.x +| 2.11.x +| 0.2.x +| 3.0.x / 3.1.x^**(*)**^ +| 17+ +|=== + + +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. +Prior to version `1.0.0`, the auto-configuration support exists in the framework itself. +^**(*)**^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.