Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove shadow artifacts from API tree #9479

Closed
htuch opened this issue Dec 25, 2019 · 5 comments · Fixed by #18091
Closed

Remove shadow artifacts from API tree #9479

htuch opened this issue Dec 25, 2019 · 5 comments · Fixed by #18091
Assignees
@akonradi
Labels
api/v3 Major version release @ end of Q3 2019 no stalebot Disables stalebot from closing an issue priority/high
Milestone
1.20.0

Comments

@htuch
Copy link
Member

htuch commented Dec 25, 2019

As part of #8082, we introduced shadow protos for Envoy internal use (see https://docs.google.com/document/d/1mGO9LtVo7t4Lph7WlmyGCxXye3h6j29z3JZvIBbs_D0/edit# for rationale).

Ultimately, we should not be checking into the repository these generated artifacts. If we want to keep shadowing (for convenience), we should be using protoxform to generate the desired shadows prior to invoking PGV, to generate shadows.

Preferably, we handle future deprecations without the need for shadowing, in v4+.
@htuch htuch added api/v4 Major version release @ end of Q3 2020 help wanted Needs help! labels Dec 25, 2019
This was referenced Dec 26, 2019
Merged
Closed
@mattklein123 mattklein123 added this to the 1.14.0 milestone Dec 26, 2019
htuch added a commit that referenced this issue Dec 29, 2019
@htuch
api: shadowing for API protos. (#9429)
da5fb5c 
This is intended to simplify the internal handling of deprecations during API boosting.

See https://docs.google.com/document/d/1mGO9LtVo7t4Lph7WlmyGCxXye3h6j29z3JZvIBbs_D0/edit

Ultimately the plan is to hide this all as a build artifact in Bazel cache, but due to the technical complexity of the pure Bazel solution (involving changes spanning PGV, protoxform, API build rules), we will use checked-in artifacts for 1.13.0.

Risk level: Low
Testing: Additional API test and protoxform golden test.

Part of #8082

This should be unwound in the future with #9479

Signed-off-by: Harvey Tuch <htuch@google.com>
@sthagen sthagen mentioned this issue Dec 29, 2019
Merged
prakhag1 pushed a commit to prakhag1/envoy that referenced this issue Jan 3, 2020
@htuch @prakhag1
api: shadowing for API protos. (envoyproxy#9429)
402e230 
This is intended to simplify the internal handling of deprecations during API boosting.

See https://docs.google.com/document/d/1mGO9LtVo7t4Lph7WlmyGCxXye3h6j29z3JZvIBbs_D0/edit

Ultimately the plan is to hide this all as a build artifact in Bazel cache, but due to the technical complexity of the pure Bazel solution (involving changes spanning PGV, protoxform, API build rules), we will use checked-in artifacts for 1.13.0.

Risk level: Low
Testing: Additional API test and protoxform golden test.

Part of envoyproxy#8082

This should be unwound in the future with envoyproxy#9479

Signed-off-by: Harvey Tuch <htuch@google.com>
Signed-off-by: Prakhar <prakhar_au@yahoo.com>
@htuch htuch added api/v3 Major version release @ end of Q3 2019 priority/high and removed api/v4 Major version release @ end of Q3 2020 labels Mar 12, 2020
@htuch htuch modified the milestones: 1.14.0, 1.15.0 Mar 18, 2020
@htuch
Copy link
Member Author

htuch commented Jun 9, 2020

Tagging for collection in #10943

@mattklein123 mattklein123 modified the milestones: 1.15.0, 1.16.0 Jun 17, 2020
@akonradi
Copy link
Contributor

Incorporating shadow generation into the Bazel build would greatly speed up development. Running the proto formatter takes a long time and if we can use Bazel for this, we can leverage its caching to avoid unnecessary checks/re-generation.

@akonradi
Copy link
Contributor

I think this is something I could take on. I'd love for this to be faster, and building it into our build process should help with that.

@htuch
Copy link
Member Author

htuch commented Jul 20, 2020

@akonradi that would be fantastic. Keep in mind that we plan on removing v2 by EOY, so I'd use that to temper how much you invest here. But given your awesome Bazel chops, I'm optimistic :)

@htuch htuch removed the help wanted Needs help! label Jul 20, 2020
@stale
Copy link

stale bot commented Aug 23, 2020

This issue has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in the next 7 days unless it is tagged "help wanted" or other activity occurs. Thank you for your contributions.

@stale stale bot added the stale stalebot believes this issue/PR has not been touched recently label Aug 23, 2020
@htuch htuch added no stalebot Disables stalebot from closing an issue and removed stale stalebot believes this issue/PR has not been touched recently labels Aug 24, 2020
@mattklein123 mattklein123 modified the milestones: 1.16.0, 1.17.0 Oct 4, 2020
@mattklein123 mattklein123 modified the milestones: 1.17.0, 1.18.0 Jan 7, 2021
@mattklein123 mattklein123 modified the milestones: 1.18.0, 1.19.0 Apr 25, 2021
@mattklein123 mattklein123 modified the milestones: 1.19.0, 1.20.0 Jul 7, 2021
@htuch htuch mentioned this issue Sep 12, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@akonradi akonradi

Labels
api/v3 Major version release @ end of Q3 2019 no stalebot Disables stalebot from closing an issue priority/high
Projects
None yet
Milestone
1.20.0
Development

Successfully merging a pull request may close this issue.

api: remove generated_api_shadow htuch/envoy
3 participants
@akonradi @mattklein123 @htuch