Skip to content

Commit 1089f6c

Browse files
committed
Mention API is stable now library is in 1.0.0
(cherry picked from commit c48e8f6)
1 parent 8a6c2ca commit 1089f6c

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

Diff for: README.adoc

+5-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ Please refer to the https://rabbitmq.github.io/rabbitmq-stream-java-client/stabl
1616

1717
== Project Maturity
1818

19-
The project is in development and stabilization phase.
20-
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.
19+
The library is stable and production-ready.
20+
21+
== Versioning
22+
23+
This library uses https://semver.org/[semantic versioning].
2124

2225
== Support
2326

Diff for: src/docs/asciidoc/overview.adoc

+3-14
Original file line numberDiff line numberDiff line change
@@ -75,30 +75,19 @@ recovery and automatic re-subscription for consumers.
7575

7676
== Versioning
7777

78-
The RabbitMQ Stream Java Client is in development and stabilization phase.
79-
When the stabilization phase ends, a 1.0.0 version will be cut, and
80-
https://semver.org/[semantic versioning] is likely to be enforced.
78+
This library uses https://semver.org/[semantic versioning].
8179

82-
Before reaching the stable phase, the client will use a versioning scheme of `[0.MINOR.PATCH]` where:
83-
84-
* `0` indicates the project is still in a stabilization phase.
85-
* `MINOR` is a 0-based number incrementing with each new release cycle. It generally reflects significant changes like new features and potentially some programming interfaces changes.
86-
* `PATCH` is a 0-based number incrementing with each service release, that is bux fixes.
87-
88-
Breaking changes between releases can happen but will be kept to a minimum.
8980
The next section provides more details about the evolution of programming interfaces.
9081

9182
[[stability-of-programming-interfaces]]
9283
== Stability of Programming Interfaces
9384

94-
The RabbitMQ Stream Java Client is in active development but its programming interfaces will remain as stable as possible.
95-
There is no guarantee though that they will remain completely stable, at least until it reaches version 1.0.0.
96-
9785
The client contains 2 sets of programming interfaces whose stability are of interest for application developers:
9886

9987
* Application Programming Interfaces (API): those are the ones used to write application logic.
10088
They include the interfaces and classes in the `com.rabbitmq.stream` package (e.g. `Producer`, `Consumer`, `Message`).
101-
These API constitute the main programming model of the client and will be kept as stable as possible.
89+
These API constitute the main programming model of the client and are kept as stable as possible.
90+
New features may require to add methods to existing interfaces.
10291
* Service Provider Interfaces (SPI): those are interfaces to implement mainly technical behavior in the client.
10392
They are not meant to be used to implement application logic.
10493
Application developers may have to refer to them in the configuration phase and if they want to customize some internal behavior of the client.

0 commit comments

Comments
 (0)