Clarify dependency coordinates in documentation
This commit is contained in:
@@ -5,6 +5,25 @@ 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:
|
||||
@@ -14,6 +33,26 @@ This is considered an "experimental" GA, defined as:
|
||||
|
||||
[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)
|
||||
|
||||
@@ -23,8 +23,52 @@ The following is the compatibility matrix:
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
**1.0.x or later**
|
||||
|
||||
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.
|
||||
|
||||
However, prior to version `1.0.0`, the auto-configuration support exists in the framework itself.
|
||||
[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.
|
||||
^**(*)**^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'
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
Reference in New Issue
Block a user