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.

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

Generate protobuf code for Go and Python services #67

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

CharlieTLe
Copy link
Owner

Part of open-telemetry#1787 to generate profobuf files for all services.

This should help unblock
open-telemetry#1754 to allow dependabot to manage dependecy upgrades for the Go services.

There are new Makefile recipes for managing the protobuf files.

  1. docker-generate-protobuf - to generate the protobuf files with docker so that the only dependency on the machine needed is docker.
  2. clean - to remove the protobuf files generated
  3. check-clean-work-tree - to check that the working tree is clean and to help with verifying that the protobuf files are updated for all of the services when there are changes to the protobuf definition.

Changes

Please provide a brief description of the changes here.

Merge Requirements

For new features contributions, please make sure you have completed the following
essential items:

  • CHANGELOG.md updated to document new feature additions
  • Appropriate documentation updates in the docs
  • Appropriate Helm chart updates in the helm-charts

Maintainers will not merge until the above have been completed. If you're unsure
which docs need to be changed ping the
@open-telemetry/demo-approvers.

@CharlieTLe CharlieTLe force-pushed the genproto-go-python branch 3 times, most recently from 46b4930 to 06f63cb Compare November 25, 2024 22:56
Part of open-telemetry#1787
to generate profobuf files for all services.

This should help unblock
open-telemetry#1754 to allow
dependabot to manage dependecy upgrades for the Go services.

There are new Makefile recipes for managing the protobuf files.

1. docker-generate-protobuf - to generate the protobuf files with docker
   so that the only dependency on the machine needed is docker.
2. clean - to remove the protobuf files generated
3. check-clean-work-tree - to check that the working tree is clean and
   to help with verifying that the protobuf files are updated for all of
   the services when there are changes to the protobuf definition.

There's a new check in the GitHub Actions workflow to verify that the
protobuf code is generated. It is only verifying that the protobuf code
is generated for Go and Python, but other services can apply the same
workflow by updating the docker-gen-proto.sh script to uncomment the
function call for the service.

Signed-off-by: Charlie Le <[email protected]>
Add dependabot configuration for Python dependencies.

* Add a new entry for the Python ecosystem in `.github/dependabot.yml`
  - Set the directory to `src/recommendationservice`
  - Set the schedule interval to `daily`
  - Add a label `dependencies`

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/CharlieTLe/opentelemetry-demo?shareId=XXXX-XXXX-XXXX-XXXX).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant