Skip to content

Commit a9cf1fe

Browse files
committed
Clarify dependency coordinates in documentation
1 parent e83d28d commit a9cf1fe

File tree

2 files changed

+84
-1
lines changed

2 files changed

+84
-1
lines changed

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,25 @@ 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+
----
827
All components (`the core + Spring Boot autoconfiguration + Spring Cloud Stream binder`) reside in the `spring-pulsar` Github repository.
928

1029
This is considered an "experimental" GA, defined as:
@@ -14,6 +33,26 @@ This is considered an "experimental" GA, defined as:
1433

1534
[discrete]
1635
== 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+
----
1756
This is the "full" GA and the components are split as follows (in-progress):
1857

1958
- the core stays in the `spring-pulsar` repo (`main` branch)

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

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

2424
[NOTE]
2525
====
26+
**1.0.x or later**
27+
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+
2630
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.
2731
28-
However, prior to version `1.0.0`, the auto-configuration support exists in the framework itself.
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.
2954
^**(*)**^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+
----
3074
====

0 commit comments

Comments
 (0)