Skip to content

Commit d7ad0cd

Browse files
committed
Add repositories declaration
1 parent 1310c5c commit d7ad0cd

File tree

2 files changed

+68
-8
lines changed

2 files changed

+68
-8
lines changed

README.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ The library requires Java 8 or more.
3333

3434
=== Documentation
3535

36+
==== Release
37+
38+
TBD
39+
40+
==== Milestone
41+
42+
TDB
43+
44+
==== Snapshot
45+
3646
* https://rabbitmq.github.io/rabbitmq-stream-java-client/snapshot/htmlsingle/[Reference documentation]
3747
* https://rabbitmq.github.io/rabbitmq-stream-java-client/snapshot/api/com/rabbitmq/stream/package-summary.html[API documentation]
3848

src/docs/asciidoc/setup.adoc

Lines changed: 58 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,61 @@ library for <<api.adoc#working-with-complex-messages,AMQP 1.0 message encoding a
115115
</dependency>
116116
117117
</dependencies>
118+
----
119+
120+
Milestones and snapshots require to declare the <<milestones-and-snapshots,appropriate repository>>.
121+
122+
==== Gradle
123+
124+
.build.gradle
125+
[source,groovy,subs="attributes,specialcharacters"]
126+
----
127+
dependencies {
128+
compile "com.rabbitmq:stream-client:{project-version}"
129+
compile "org.apache.qpid:proton-j:{protonj-version}"
130+
}
131+
----
132+
133+
Milestones and snapshots require to declare the <<milestones-and-snapshots,appropriate repository>>.
134+
135+
[[milestones-and-snapshots]]
136+
=== Milestones and Snapshots
118137

138+
Releases are available from Maven Central, which does not require specific declaration. Milestones and snapshots are available from repositories which must be declared in the dependency management configuration.
139+
140+
For milestones, with Maven:
141+
142+
.Milestone repository declaration for Maven
143+
[source,xml,subs="attributes,specialcharacters"]
144+
----
145+
<repositories>
146+
147+
<repository>
148+
<id>packagecloud-rabbitmq-maven-milestones</id>
149+
<url>https://packagecloud.io/rabbitmq/maven-milestones/maven2</url>
150+
<releases><enabled>true</enabled></releases>
151+
<snapshots><enabled>false</enabled></snapshots>
152+
</repository>
153+
154+
</repositories>
155+
----
156+
157+
For milestones, with Gradle:
158+
159+
.Milestone repository declaration for Gradle:
160+
[source,groovy,subs="attributes,specialcharacters"]
161+
----
162+
repositories {
163+
maven { url "https://packagecloud.io/rabbitmq/maven-milestones/maven2" }
164+
mavenCentral()
165+
}
166+
----
167+
168+
For snapshots, with Maven:
169+
170+
.Snaphost repository declaration for Maven
171+
[source,xml,subs="attributes,specialcharacters"]
172+
----
119173
<repositories>
120174
121175
<repository>
@@ -128,18 +182,14 @@ library for <<api.adoc#working-with-complex-messages,AMQP 1.0 message encoding a
128182
</repositories>
129183
----
130184

131-
==== Gradle
185+
For snapshots, with Gradle:
132186

133-
.build.gradle
187+
.Snaphost repository declaration for Gradle:
134188
[source,groovy,subs="attributes,specialcharacters"]
135189
----
136-
dependencies {
137-
compile "com.rabbitmq:stream-client:{project-version}"
138-
compile "org.apache.qpid:proton-j:{protonj-version}"
139-
}
140-
141190
repositories {
142191
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
143192
mavenCentral()
144193
}
145-
----
194+
----
195+

0 commit comments

Comments
 (0)