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

Update proto toolchain #5986

Closed
briandealwis opened this issue Jun 9, 2021 · 1 comment · Fixed by #6567
Closed

Update proto toolchain #5986

briandealwis opened this issue Jun 9, 2021 · 1 comment · Fixed by #6567
Labels
kind/todo implementation task/epic for the skaffold team tech-debt Issues that relate to paying back technical debt.

Comments

@briandealwis
Copy link
Member

Our toolchain in hack/proto/Dockerfile is rather behind, but a simple update of versions doesn't work as the .pb.go files aren't generated.

  • update protoc to 3.17.3: if we used a debian image (golang:1.15 instead of -alpine) then we could use the downloaded protoc, but debian's jq is 1.5
  • update grpc-gateway to v2 — the protoc-gen-swagger has been renamed to protc-gen-openapiv2, but it seems the proto needs some additional annotations
  • verify that use of jq to rewrite of the generated swagger doc (title → description) is necessary?
@briandealwis briandealwis added kind/todo implementation task/epic for the skaffold team tech-debt Issues that relate to paying back technical debt. labels Jun 9, 2021
@briandealwis briandealwis added this to the v1.27.0 milestone Jun 9, 2021
@MarlonGamez MarlonGamez mentioned this issue Jun 23, 2021
Merged
@briandealwis
Copy link
Member Author

I suspect this jq malarkey can be handled by setting some specific options in the proto. I'm not clear what the title/description issues were in the generated swagger though.

This is where the proto is turned into the swagger implementation:
https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-openapiv2/internal/genopenapi/template.go

@MarlonGamez MarlonGamez mentioned this issue Jun 29, 2021
Merged
@tejal29 tejal29 removed this from the v1.27.0 milestone Jul 16, 2021
@briandealwis briandealwis mentioned this issue Sep 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/todo implementation task/epic for the skaffold team tech-debt Issues that relate to paying back technical debt.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update to grpc-gateway v2 briandealwis/skaffold
2 participants
@briandealwis @tejal29