-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
Import open-telemetry/opentelemetry-proto submodule and generate protobuf bindings locally #942
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's otel-collector doing with this same problem?
@lizthegrey for backstory: open-telemetry/opentelemetry-proto#79 (comment) and from that the collector solution: open-telemetry/opentelemetry-collector#1037 |
Ah, excellent, so a similar solution of checking the generated .pb.go files in subject to normal code review, but not run automatically from circleci and instead run by hand. We should consider upstreaming the Github Action so that they get the benefit of it too! |
🎉 🎉 🎉 |
Recommendation: in Jaeger we have a separate CI step "check-proto" that re-runs the .pb.go file generation and verifies that checked-in version is the same as would-be-generated one. It catches issues when something in the toolchain changes, like the version of generator plugin. |
Thanks @evantorrie |
Fixes #793 and will allow opentelemetry-proto repository maintainers to remove the generated Go code from their repo.
internal/opentelemetry-proto
.internal/opentelemetry-proto-gen
.github.com/open-telemetry/opentelemetry-proto
now changed to reference internal packagego.opentelemetry.io/otel/internal/opentelemetry-proto-gen
.In normal workflow, the git submodule should not be populated. Only do so with
git submodule update --init
when a new version of the protobuf sources are released in the opentelemetry-proto repository and you need to force the workflow to regenerate updated Go bindings ininternal/opentelemetry-proto-gen
.