Spring/spring-pulsar
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish "Clarify dependency coordinates in documentation"

Browse Source
This commit is contained in:
Chris Bono
2023-09-22 00:16:34 -05:00
parent a9cf1fe5e3
commit 97d524eeaa
4 changed files with 49 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
spring-pulsar-docs/src/main/asciidoc/project-state.adoc
View File

@@ -5,25 +5,6 @@ The evolution of the project (by version) is as follows:
[discrete]
== Version 0.2.x
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
<dependencies>
<dependency>
<groupId>org.springframework.pulsar</groupId>
<artifactId>spring-pulsar-spring-boot-starter</artifactId>
<version>0.2.x</version>
</dependency>
</dependencies>
----
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
.Gradle
----
dependencies {
implementation 'org.springframework.pulsar:spring-pulsar-spring-boot-starter:0.2.x'
}
----
All components (`the core + Spring Boot autoconfiguration + Spring Cloud Stream binder`) reside in the `spring-pulsar` Github repository.
This is considered an "experimental" GA, defined as:
@@ -31,32 +12,21 @@ This is considered an "experimental" GA, defined as:
- code and functionality is production ready, but decision has not been made to support the project permanently
- available on Maven Central using a major version of `0` to indicate its nature
NOTE: Until the GA release, the recommended version of the framework is `0.2.x`.
[discrete]
== Version 1.0.x
Due to becoming an official Spring Boot project, the coordinates used to identify the artifact in your dependency management tool have changed in addition to the version number.
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-pulsar</artifactId>
<version>3.2.x</version>
</dependency>
</dependencies>
----
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
.Gradle
----
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-pulsar:3.2.x'
}
----
This is the "full" GA and the components are split as follows (in-progress):
- the core stays in the `spring-pulsar` repo (`main` branch)
- the autoconfiguration moves to the Spring Boot project (targeting Spring Boot `3.2.0`)
- the binder moves to the Spring Cloud Stream project (targeting SCSt `4.1.0`)
NOTE: Until the GA release, the recommended version of the framework is `0.2.x`.
[CAUTION]
====
Be aware that as the autoconfiguration moves to the Spring Boot project the dependency coordinates for the starter modules also change as follows:
* The group id goes from `org.springframework.pulsar` to `org.springframework.boot`
* The artifact id goes from `spring-pulsar-spring-boot-starter` to `spring-boot-starter-pulsar` (same pattern for the reactive starter)
* The version goes from `0.2.x` to `3.2.x`
====

20
spring-pulsar-docs/src/main/asciidoc/quick-tour.adoc
View File

@@ -32,8 +32,24 @@ dependencies {
====
When using `Version 0.2.x` the above coordinates change as follows:
* `groupId` -> `org.springframework.pulsar`
* `artifactId` -> `spring-pulsar-spring-boot-starter`
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
<dependencies>
<dependency>
<groupId>org.springframework.pulsar</groupId>
<artifactId>spring-pulsar-spring-boot-starter</artifactId>
<version>0.2.0</version>
</dependency>
</dependencies>
----
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
.Gradle
----
dependencies {
implementation 'org.springframework.pulsar:spring-pulsar-spring-boot-starter:0.2.0'
}
----
====
== Application Code

21
spring-pulsar-docs/src/main/asciidoc/reactive-quick-tour.adoc
View File

@@ -32,10 +32,27 @@ dependencies {
====
When using `Version 0.2.x` the above coordinates change as follows:
* `groupId` -> `org.springframework.pulsar`
* `artifactId` -> `spring-pulsar-reactive-spring-boot-starter`
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
<dependencies>
<dependency>
<groupId>org.springframework.pulsar</groupId>
<artifactId>spring-pulsar-reactive-spring-boot-starter</artifactId>
<version>0.2.0</version>
</dependency>
</dependencies>
----
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
.Gradle
----
dependencies {
implementation 'org.springframework.pulsar:spring-pulsar-reactive-spring-boot-starter:0.2.0'
}
----
====
== Application Code
Here is the application source code:

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

@@ -23,52 +23,8 @@ The following is the compatibility matrix:
[NOTE]
====
**1.0.x or later**
In version `1.0.0` the autoconfiguration 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.
Due to becoming an official Spring Boot project, the coordinates used to identify the artifact in your dependency management tool have changed in addition to the version number.
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.
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-pulsar</artifactId>
<version>3.2.x</version>
</dependency>
</dependencies>
----
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
.Gradle
----
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-pulsar:3.2.x'
}
----
**0.2.0**
Prior to version `1.0.0`, the auto-configuration support exists in the framework itself.
However, prior to version `1.0.0`, the autoconfiguration 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.
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
.Maven
----
<dependencies>
<dependency>
<groupId>org.springframework.pulsar</groupId>
<artifactId>spring-pulsar-spring-boot-starter</artifactId>
<version>0.2.0</version>
</dependency>
</dependencies>
----
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
.Gradle
----
dependencies {
implementation 'org.springframework.pulsar:spring-pulsar-spring-boot-starter:0.2.0'
}
----
====