You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+5-2
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,11 @@ Please refer to the https://rabbitmq.github.io/rabbitmq-stream-java-client/stabl
16
16
17
17
== Project Maturity
18
18
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].
Copy file name to clipboardExpand all lines: src/docs/asciidoc/overview.adoc
+3-14
Original file line number
Diff line number
Diff line change
@@ -75,30 +75,19 @@ recovery and automatic re-subscription for consumers.
75
75
76
76
== Versioning
77
77
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].
81
79
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.
89
80
The next section provides more details about the evolution of programming interfaces.
90
81
91
82
[[stability-of-programming-interfaces]]
92
83
== Stability of Programming Interfaces
93
84
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
-
97
85
The client contains 2 sets of programming interfaces whose stability are of interest for application developers:
98
86
99
87
* Application Programming Interfaces (API): those are the ones used to write application logic.
100
88
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.
102
91
* Service Provider Interfaces (SPI): those are interfaces to implement mainly technical behavior in the client.
103
92
They are not meant to be used to implement application logic.
104
93
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