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

Replace gRPC code generation tool from Znly/protoc to Buf #2295

Closed
wants to merge 3 commits into from

Conversation

shivas1516
Copy link

What this PR does / why we need it:
This PR replaces the outdated code generation tool 'znly/protoc' with Buf for generating gRPC code. The change is necessary due to the lack of maintenance and updates for 'znly/protoc', ensuring compatibility, security, and access to new features with Buf.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes: #2141

Checklist:

  • Docs included if any changes are user facing

Signed-off-by: SIVASUBRAMANIAM L <[email protected]>
@shivas1516
Copy link
Author

@tenzen-y I reached out to the Buf community and received valuable suggestions on migrating our project from znly/protoc to Buf. Following their guidance, I successfully set up Buf and generated the code. However, during testing, some test cases are failing. I've been reviewing them for more than two days now. Any suggestions on resolving these failures would be greatly appreciated as it would help me to solve them. Thank you!

Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late reply @shivas1516 and thank you for your contribution!
I think, we should update our generate scripts to include this new way of gRPC code generation in our CI/CD.

@shivas1516
Copy link
Author

Sorry for the late reply @shivas1516 and thank you for your contribution!
I think, we should update our generate scripts to include this new way of gRPC code generation in our CI/CD.

Sir @andreyvelich , If you think I can do this task(as mentioned this is a good first issue), Please give any suggestions or guidance. So that, I can try my level best to complete this and make a meaningful contribute to Kuberflow.

@andreyvelich
Copy link
Member

Sorry for the late reply @shivas1516 and thank you for your contribution!
I think, we should update our generate scripts to include this new way of gRPC code generation in our CI/CD.

Sir @andreyvelich , If you think I can do this task(as mentioned this is a good first issue), Please give any suggestions or guidance. So that, I can try my level best to complete this and make a meaningful contribute to Kuberflow.

Did you generate all files using the following command:

buf generate --template=buf.gen.yaml $proto

We might need to add this CLI as a requirements to our docs: https://github.com/kubeflow/katib/blob/master/docs/developer-guide.md#requirements

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign gaocegege for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shivas1516 Please can you collaborate with @forsaken628 to update this PR with required changes from this PR: #2344.

For example, we need to have hack script to update protobuf: https://github.com/kubeflow/katib/pull/2344/files#diff-a2e208c47cfc7e9e58c84651f3eb55489fb00b7303c249eab47775a8f52d7ba2

Feel free to use #kubeflow-katib Slack channel to discuss what we need to add in this PR to get it merged.

@andreyvelich
Copy link
Member

As we discussed on #kubeflow-training Slack, we will work on this PR: #2344 to update buf.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace the tool of code generator for the gRPC API
2 participants