api: tools/docs to support v2 freeze, v4alpha cut.#10636
Merged
htuch merged 9 commits intoenvoyproxy:masterfrom Apr 7, 2020
Merged
api: tools/docs to support v2 freeze, v4alpha cut.#10636htuch merged 9 commits intoenvoyproxy:masterfrom
htuch merged 9 commits intoenvoyproxy:masterfrom
Conversation
This patch introduces the tools/docs for a new flow for protoxform: freeze. This performs a major version freeze and bump by modifying package_version_status. Tooling now needs to deal with 3 possible versions (v2, v3, v4alpha). The following contributions are made in the patch: * Tooling added to support v2 APIs freeze, transitioning v3 to active and generating v4alpha. * A new tool, merge_active_shadow.py, is introduced to combine hand-edited active v3 API protos with the v2 implied shadows for deprecated fields. * The type database now spans v2 and v3 (and implied v4alpha files). * api_proto_plugins can now take extra args on the Bazel CLI; this is used to plumb in the freeze arg to protoxform. * Docs are updated to reflect the v3 flow that developers should now follow. Part of envoyproxy#10355 This is the tools/docs component of envoyproxy#10601. See envoyproxy#10601 for the resulting API protos generated by a freeze/fix cycle. Risk level: Low (tooling only, no API changes yet) Testing: new golden protos tests for protoxform, unit tests for merge_active_shadow. Signed-off-by: Harvey Tuch <htuch@google.com>
mattklein123
previously approved these changes
Apr 3, 2020
Member
mattklein123
left a comment
There was a problem hiding this comment.
I skimmed, but I understand at a high level and this LGTM. Amazing work!
lizan
suggested changes
Apr 3, 2020
Member
lizan
left a comment
There was a problem hiding this comment.
Thanks, this is great! Just minor comments.
Signed-off-by: Harvey Tuch <htuch@google.com>
…ools Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: Harvey Tuch <htuch@google.com>
mattklein123
previously approved these changes
Apr 6, 2020
Signed-off-by: Harvey Tuch <htuch@google.com>
Member
Author
|
@cpakulski thanks for #10667, this is now added to the updated instructions in this PR. |
Signed-off-by: Harvey Tuch <htuch@google.com>
lizan
approved these changes
Apr 6, 2020
Member
|
Merge master to fix CI? /wait |
htuch
added a commit
to htuch/envoy
that referenced
this pull request
Apr 7, 2020
This patch performs a major version freeze and bump by modifying package_version_status, using the tooling developed in envoyproxy#10636. Specifically: * v2 APIs are frozen (except for where they are the latest in their package history and still active) * v3 APIs are transitioned to be active * Candidate v4alpha APIs are generated (not used by Envoy yet) Fixes envoyproxy#10355 Risk level: medium (entire API's files are modified, visually verified to ensure things look sane, all tests pass) Testing: CI Signed-off-by: Harvey Tuch <htuch@google.com>
htuch
added a commit
that referenced
this pull request
Apr 7, 2020
This patch performs a major version freeze and bump by modifying package_version_status, using the tooling developed in #10636. Specifically: v2 APIs are frozen (except for where they are the latest in their package history and still active) v3 APIs are transitioned to be active Candidate v4alpha APIs are generated (not used by Envoy yet) Fixes #10355 Risk level: medium (entire API's files are modified, visually verified to ensure things look sane, all tests pass) Testing: CI Signed-off-by: Harvey Tuch <htuch@google.com>
| srcs = [ | ||
| "active_non_terminal.proto", | ||
| "active_terminal.proto", | ||
| "frozen.proto", |
Contributor
There was a problem hiding this comment.
None of the previous 3 proto source files exist. This breaks compilation of //tools/...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This patch introduces the tools/docs for a new flow for protoxform: freeze.
This performs a major version freeze and bump by modifying
package_version_status. Tooling now needs to deal with 3 possible versions (v2,
v3, v4alpha). The following contributions are made in the patch:
and generating v4alpha.
active v3 API protos with the v2 implied shadows for deprecated fields.
used to plumb in the freeze arg to protoxform.
follow.
Part of #10355
This is the tools/docs component of #10601. See #10601 for the resulting
API protos generated by a freeze/fix cycle.
Risk level: Low (tooling only, no API changes yet)
Testing: new golden protos tests for protoxform, unit tests for merge_active_shadow.
Signed-off-by: Harvey Tuch htuch@google.com