api: introduce WiP file-level annotations.#9826
api: introduce WiP file-level annotations.#9826htuch wants to merge 1 commit intoenvoyproxy:masterfrom
Conversation
This is the new style for indicating a file is WiP and subject to breaking changes. Rather than rely on alpha major versions, which are coarse grained and introduce migration difficulties for operators, we use a file-level annotation. Risk level: Low Testing: API/docs build, manual inspection of docs. Fixes envoyproxy#9769. Signed-off-by: Harvey Tuch <htuch@google.com>
|
CC @markdroth @dfawley @ejona86 FYI, hopefully not too controversial given that we agreed that well telegraphed API instability is OK. |
SGTM, thank you for the heads-up. |
|
This pull request has been automatically marked as stale because it has not had activity in the last 7 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions! |
stale
Bot
added
the
stale
stale
Bot
removed
the
stale
lizan
left a comment
lizan
left a comment
There was a problem hiding this comment.
Was revisiting this for new extension, and found (1) in #9769 (comment) doesn't have much tooling complex if we use move_to_package. So I guess we can continue to use vNalpha, WDYT @htuch?
| option java_outer_classname = "TapProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_migrate).move_to_package = | ||
| "envoy.extensions.transport_sockets.tap.v3"; |
There was a problem hiding this comment.
We can use this annotation altogether with the status, we can easily achieve v3alpha package for files subject to breaking change.
|
@lizan is going to take over this change so I'm going to close this out and he can open a new PR. Thank you! |
5 participants
This is the new style for indicating a file is WiP and subject to
breaking changes. Rather than rely on alpha major versions, which are
coarse grained and introduce migration difficulties for operators, we
use a file-level annotation.
Risk level: Low
Testing: API/docs build, manual inspection of docs.
Fixes #9769.
Signed-off-by: Harvey Tuch htuch@google.com