Skip to content

Commit b624ec9

Browse files
acogoluegnesacogoluegnes
committed
Adapt SAC branch to main before merging
1 parent 8cfb410 commit b624ec9

File tree

6 files changed

+45
-32
lines changed

6 files changed

+45
-32
lines changed

‎.github/workflows/test-sac.yml renamed to ‎.github/workflows/test-3.11.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
name: Test SAC branch against RabbitMQ 3.11 alpha
1+
name: Test against RabbitMQ 3.11 alpha
22

33
on:
44
push:
55
branches:
6-
- single-active-consumer
7-
6+
- main
7+
pull_request:
8+
branches:
9+
- main
810
jobs:
911
build:
1012
runs-on: ubuntu-22.04

‎README.adoc

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= RabbitMQ Stream Java Client
22

33
image:https://maven-badges.herokuapp.com/maven-central/com.rabbitmq/stream-client/badge.svg["Maven Central", link="https://maven-badges.herokuapp.com/maven-central/com.rabbitmq/stream-client"]
4-
image:https://github.com/rabbitmq/rabbitmq-stream-java-client/workflows/Build%20(Linux,%20Single%20Active%20Consumer)/badge.svg?branch=single-active-consumer["Build Status", link="https://github.com/rabbitmq/rabbitmq-stream-java-client/actions/workflows/test-linux-sac.yml"]
4+
image:https://github.com/rabbitmq/rabbitmq-stream-java-client/workflows/Build%20(Linux)/badge.svg?branch=main["Build Status", link="https://github.com/rabbitmq/rabbitmq-stream-java-client/actions?query=workflow%3A%22Build+%28Linux%29%22+branch%3Amain"]
55
image:https://codecov.io/gh/rabbitmq/rabbitmq-stream-java-client/branch/main/graph/badge.svg?token=CFZ6EHW47J["Code Coverage", link="https://codecov.io/gh/rabbitmq/rabbitmq-stream-java-client"]
66

77
The RabbitMQ Stream Java Client is a Java library to communicate with
@@ -10,16 +10,16 @@ It allows to create and delete streams, as well as to publish to and consume fro
1010
these streams.
1111

1212
The client ships also with a
13-
https://rabbitmq.github.io/rabbitmq-stream-java-client/sac/htmlsingle/#the-performance-tool[performance tool].
13+
https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#the-performance-tool[performance tool].
1414

15-
Please refer to the https://rabbitmq.github.io/rabbitmq-stream-java-client/sac/htmlsingle/[documentation]
16-
(https://rabbitmq.github.io/rabbitmq-stream-java-client/sac/pdf/index.pdf[PDF])
15+
Please refer to the https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/[documentation]
16+
(https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/pdf/index.pdf[PDF])
1717
to find out more.
1818

1919
== Project Maturity
2020

2121
The project is in development and stabilization phase.
22-
Features and API are subject to change, but https://rabbitmq.github.io/rabbitmq-stream-java-client/sac/htmlsingle/#stability-of-programming-interfaces[breaking changes] will be kept to a minimum.
22+
Features and API are subject to change, but https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/#stability-of-programming-interfaces[breaking changes] will be kept to a minimum.
2323

2424
== Support
2525

@@ -34,10 +34,15 @@ The library requires Java 8 or later. Java 11 is recommended.
3434

3535
=== Documentation
3636

37+
==== Release
38+
39+
* https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/htmlsingle/[Reference documentation]
40+
* https://rabbitmq.github.io/rabbitmq-stream-java-client/stable/api/com/rabbitmq/stream/package-summary.html[API documentation]
41+
3742
==== Snapshot
3843

39-
* https://rabbitmq.github.io/rabbitmq-stream-java-client/sac/htmlsingle/[Reference documentation]
40-
* https://rabbitmq.github.io/rabbitmq-stream-java-client/sac/api/com/rabbitmq/stream/package-summary.html[API documentation]
44+
* https://rabbitmq.github.io/rabbitmq-stream-java-client/snapshot/htmlsingle/[Reference documentation]
45+
* https://rabbitmq.github.io/rabbitmq-stream-java-client/snapshot/api/com/rabbitmq/stream/package-summary.html[API documentation]
4146

4247
== Versioning
4348

@@ -70,7 +75,7 @@ Launch the broker:
7075
----
7176
docker run -it --rm --name rabbitmq -p 5552:5552 -p 5672:5672 \
7277
-e RABBITMQ_SERVER_ADDITIONAL_ERL_ARGS='-rabbitmq_stream advertised_host localhost' \
73-
pivotalrabbitmq/rabbitmq-stream:sac
78+
rabbitmq:3.10
7479
----
7580

7681
Enable the stream plugin:
@@ -106,4 +111,4 @@ Please launch the `./mvnw spotless:apply` command to format your changes before
106111

107112
(c) 2020-2022, VMware Inc or its affiliates.
108113

109-
Double licensed under the MPL2.0 and ASL2. See link:LICENSE[LICENSE] for details.
114+
Double licensed under the MPL2.0 and ASL2. See link:LICENSE[LICENSE] for details.

‎pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<modelVersion>4.0.0</modelVersion>
44

55
<groupId>com.rabbitmq</groupId>
6-
<artifactId>stream-client-sac</artifactId>
7-
<version>0.6.0-SNAPSHOT</version>
6+
<artifactId>stream-client</artifactId>
7+
<version>0.7.0-SNAPSHOT</version>
88

99
<name>RabbitMQ Stream Java Client</name>
1010
<description>The RabbitMQ Stream Java client library allows Java applications to interface with

‎publish-documentation-to-github-pages.sh

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ MESSAGE=$(git log -1 --pretty=%B)
77

88
./mvnw javadoc:javadoc -Dmaven.javadoc.skip=false
99

10-
RELEASE_VERSION="sac"
10+
RELEASE_VERSION=$(cat pom.xml | grep -oPm1 "(?<=<version>)[^<]+")
1111

1212
git checkout -- .mvn/maven.config
1313

@@ -24,6 +24,28 @@ mkdir -p $RELEASE_VERSION/api
2424
cp -r target/site/apidocs/* $RELEASE_VERSION/api/
2525
git add $RELEASE_VERSION/
2626

27+
if [[ $LATEST == "true" ]]
28+
then
29+
if [[ $RELEASE_VERSION == *[RCM]* ]]
30+
then
31+
DOC_DIR="milestone"
32+
elif [[ $RELEASE_VERSION == *SNAPSHOT* ]]
33+
then
34+
DOC_DIR="snapshot"
35+
else
36+
DOC_DIR="stable"
37+
fi
38+
39+
mkdir -p $DOC_DIR/htmlsingle
40+
cp target/generated-docs/index.html $DOC_DIR/htmlsingle
41+
mkdir -p $DOC_DIR/pdf
42+
cp target/generated-docs/index.pdf $DOC_DIR/pdf
43+
mkdir -p $DOC_DIR/api
44+
cp -r target/site/apidocs/* $DOC_DIR/api/
45+
git add $DOC_DIR/
46+
47+
fi
48+
2749
git commit -m "$MESSAGE"
2850
git push origin gh-pages
29-
git checkout single-active-consumer
51+
git checkout main

‎src/docs/asciidoc/performance-tool.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,6 @@ Snapshots are on https://github.com/rabbitmq/rabbitmq-java-tools-binaries-dev/re
99

1010
=== Using the Performance Tool
1111

12-
==== For Single Active Consumer Branch
13-
14-
Use the `pivotalrabbitmq/stream-perf-test:sac` Docker image.
15-
16-
Use JAR binary from https://github.com/rabbitmq/rabbitmq-java-tools-binaries-dev/releases (with `stream-perf-test-sac` in the name).
17-
18-
(TODO: remove this section when merging)
19-
2012
==== With Docker
2113

2214
The performance tool is available as a

‎src/docs/asciidoc/setup.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@
33
A RabbitMQ 3.9+ node with the stream plugin enabled is required. The easiest way
44
to get up and running is to use Docker.
55

6-
==== For Single Active Consumer Branch
7-
8-
Use the `pivotalrabbitmq/rabbitmq-stream` Docker image.
9-
10-
Use the generic Unix package from https://github.com/rabbitmq/rabbitmq-server-binaries-dev/releases (with `alpha-stream` in the name).
11-
12-
(TODO: remove this section when merging)
13-
146
==== With Docker
157

168
There are different ways to make the broker visible to the client application when running

0 commit comments

Comments
 (0)