Skip to content

Commit 97d524e

Browse files
onobconobc
committed
Polish "Clarify dependency coordinates in documentation"
1 parent a9cf1fe commit 97d524e

File tree

4 files changed

+49
-90
lines changed

4 files changed

+49
-90
lines changed

‎spring-pulsar-docs/src/main/asciidoc/project-state.adoc

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -5,58 +5,28 @@ The evolution of the project (by version) is as follows:
55

66
[discrete]
77
== Version 0.2.x
8-
9-
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
10-
.Maven
11-
----
12-
<dependencies>
13-
<dependency>
14-
<groupId>org.springframework.pulsar</groupId>
15-
<artifactId>spring-pulsar-spring-boot-starter</artifactId>
16-
<version>0.2.x</version>
17-
</dependency>
18-
</dependencies>
19-
----
20-
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
21-
.Gradle
22-
----
23-
dependencies {
24-
implementation 'org.springframework.pulsar:spring-pulsar-spring-boot-starter:0.2.x'
25-
}
26-
----
278
All components (`the core + Spring Boot autoconfiguration + Spring Cloud Stream binder`) reside in the `spring-pulsar` Github repository.
289

2910
This is considered an "experimental" GA, defined as:
3011

3112
- code and functionality is production ready, but decision has not been made to support the project permanently
3213
- available on Maven Central using a major version of `0` to indicate its nature
3314

15+
NOTE: Until the GA release, the recommended version of the framework is `0.2.x`.
16+
3417
[discrete]
3518
== Version 1.0.x
36-
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.
37-
38-
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
39-
.Maven
40-
----
41-
<dependencies>
42-
<dependency>
43-
<groupId>org.springframework.boot</groupId>
44-
<artifactId>spring-boot-starter-pulsar</artifactId>
45-
<version>3.2.x</version>
46-
</dependency>
47-
</dependencies>
48-
----
49-
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
50-
.Gradle
51-
----
52-
dependencies {
53-
implementation 'org.springframework.boot:spring-boot-starter-pulsar:3.2.x'
54-
}
55-
----
5619
This is the "full" GA and the components are split as follows (in-progress):
5720

5821
- the core stays in the `spring-pulsar` repo (`main` branch)
5922
- the autoconfiguration moves to the Spring Boot project (targeting Spring Boot `3.2.0`)
6023
- the binder moves to the Spring Cloud Stream project (targeting SCSt `4.1.0`)
6124

62-
NOTE: Until the GA release, the recommended version of the framework is `0.2.x`.
25+
[CAUTION]
26+
====
27+
Be aware that as the autoconfiguration moves to the Spring Boot project the dependency coordinates for the starter modules also change as follows:
28+
29+
* The group id goes from `org.springframework.pulsar` to `org.springframework.boot`
30+
* The artifact id goes from `spring-pulsar-spring-boot-starter` to `spring-boot-starter-pulsar` (same pattern for the reactive starter)
31+
* The version goes from `0.2.x` to `3.2.x`
32+
====

‎spring-pulsar-docs/src/main/asciidoc/quick-tour.adoc

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,24 @@ dependencies {
3232
====
3333
When using `Version 0.2.x` the above coordinates change as follows:
3434
35-
* `groupId` -> `org.springframework.pulsar`
36-
* `artifactId` -> `spring-pulsar-spring-boot-starter`
35+
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
36+
.Maven
37+
----
38+
<dependencies>
39+
<dependency>
40+
<groupId>org.springframework.pulsar</groupId>
41+
<artifactId>spring-pulsar-spring-boot-starter</artifactId>
42+
<version>0.2.0</version>
43+
</dependency>
44+
</dependencies>
45+
----
46+
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
47+
.Gradle
48+
----
49+
dependencies {
50+
implementation 'org.springframework.pulsar:spring-pulsar-spring-boot-starter:0.2.0'
51+
}
52+
----
3753
====
3854

3955
== Application Code

‎spring-pulsar-docs/src/main/asciidoc/reactive-quick-tour.adoc

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,27 @@ dependencies {
3232
====
3333
When using `Version 0.2.x` the above coordinates change as follows:
3434
35-
* `groupId` -> `org.springframework.pulsar`
36-
* `artifactId` -> `spring-pulsar-reactive-spring-boot-starter`
35+
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
36+
.Maven
37+
----
38+
<dependencies>
39+
<dependency>
40+
<groupId>org.springframework.pulsar</groupId>
41+
<artifactId>spring-pulsar-reactive-spring-boot-starter</artifactId>
42+
<version>0.2.0</version>
43+
</dependency>
44+
</dependencies>
45+
----
46+
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
47+
.Gradle
48+
----
49+
dependencies {
50+
implementation 'org.springframework.pulsar:spring-pulsar-reactive-spring-boot-starter:0.2.0'
51+
}
52+
----
3753
====
3854

55+
3956
== Application Code
4057

4158
Here is the application source code:

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

Lines changed: 2 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -23,52 +23,8 @@ The following is the compatibility matrix:
2323

2424
[NOTE]
2525
====
26-
**1.0.x or later**
26+
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.
2727
28-
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.
29-
30-
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.
31-
32-
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
33-
.Maven
34-
----
35-
<dependencies>
36-
<dependency>
37-
<groupId>org.springframework.boot</groupId>
38-
<artifactId>spring-boot-starter-pulsar</artifactId>
39-
<version>3.2.x</version>
40-
</dependency>
41-
</dependencies>
42-
----
43-
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
44-
.Gradle
45-
----
46-
dependencies {
47-
implementation 'org.springframework.boot:spring-boot-starter-pulsar:3.2.x'
48-
}
49-
----
50-
51-
**0.2.0**
52-
53-
Prior to version `1.0.0`, the auto-configuration support exists in the framework itself.
28+
However, prior to version `1.0.0`, the autoconfiguration support exists in the framework itself.
5429
^**(*)**^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.
55-
56-
[source,xml,indent=0,subs="verbatim,attributes",role="primary"]
57-
.Maven
58-
----
59-
<dependencies>
60-
<dependency>
61-
<groupId>org.springframework.pulsar</groupId>
62-
<artifactId>spring-pulsar-spring-boot-starter</artifactId>
63-
<version>0.2.0</version>
64-
</dependency>
65-
</dependencies>
66-
----
67-
[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"]
68-
.Gradle
69-
----
70-
dependencies {
71-
implementation 'org.springframework.pulsar:spring-pulsar-spring-boot-starter:0.2.0'
72-
}
73-
----
7430
====

0 commit comments

Comments
 (0)