feat: add experimental annotation #2853
Conversation
Annotation would serve to mark experimental features. Signed-off-by: Attila Mészáros <[email protected]>
Signed-off-by: Attila Mészáros <[email protected]>
There was a problem hiding this comment.
We have similar in SmallRye project - https://github.com/xstefank/smallrye-common/blob/main/annotation/src/main/java/io/smallrye/common/annotation/Experimental.java and I would suggest also giving this one a String argument that says why/what experimental feature this is.
Makes sense, will add, thank you! |
|
@xstefank Why is there runtime retention? |
Signed-off-by: Attila Mészáros <[email protected]>
|
@csviri we might pull this in logs or similar based on config. |
| /** | ||
| * Marks experimental features. | ||
| * | ||
| * <p>Experimental features are not yet stable and may change in future releases. Usually based on |
There was a problem hiding this comment.
Maybe we could also say that we keep changes to minor or even micro releases. But that's optional.
There was a problem hiding this comment.
Do we intend to do anything specific with this annotation? i.e. automated warning when using experimental features, or such? If not, why not use just documentation for that purpose?
To be clear, not saying we shouldn't add such an annotation, just wondering what we will use it for.
That is fair, we should define/agree on how we are going to use it. My intention is just to mark features which are either not well understood / discovered / standard feature of operator framewors as experimental, until we standardize them or possibly iterate on them a few cycles. IMHO, annotation is not just a little more visible than simple Javadoc, but helps us and the users easily search for the experimental features, and yes also possibly build some additional logic on top of it in case. |
Annotation would serve to mark experimental features.