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 vtctldclient RPC client code from vtctlservice protobufs on make proto #15561

Merged
merged 1 commit into from
Mar 24, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Mar 24, 2024

Description

This adds an additional dependency to the proto Makefile target, vtctldclient, as it is dependent on proto changes — in addition to vtadmin_web_proto_types which was already there. This way we will regenerate the vtctldclient gRPC client code when the vtctlservice.proto is changed and the protobufs are subsequently rebuilt. This ensures that our proto dependent code stays in sync.

We will also then be checking for drift in the static_checks workflow as part of the check_make_proto step.

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

We will also then be checking for drift in the static_checks workflow
as part of the check_make_proto step.

Signed-off-by: Matt Lord <[email protected]>
Copy link
Contributor

vitess-bot bot commented Mar 24, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Mar 24, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 24, 2024
@mattlord mattlord removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 24, 2024
@mattlord mattlord changed the title Generate vtctldclient client code from vtctlservice.proto on make proto Generate vtctldclient RPC client code from vtctlservice.proto on make proto Mar 24, 2024
@mattlord mattlord requested a review from dbussink March 24, 2024 16:31
@mattlord mattlord changed the title Generate vtctldclient RPC client code from vtctlservice.proto on make proto Generate vtctldclient RPC client code from vtctlservice protobufs on make proto Mar 24, 2024
Copy link

codecov bot commented Mar 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.74%. Comparing base (4f24560) to head (3c99a2f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15561      +/-   ##
==========================================
+ Coverage   65.73%   65.74%   +0.01%     
==========================================
  Files        1560     1560              
  Lines      194595   194595              
==========================================
+ Hits       127921   127946      +25     
+ Misses      66674    66649      -25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mattlord mattlord merged commit 11f2a4e into vitessio:main Mar 24, 2024
113 of 114 checks passed
@mattlord mattlord deleted the vtctldclient_client_gen branch March 24, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants