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

SetShardTabletControl: Improve flag help output #16376

Merged
merged 2 commits into from
Jul 15, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Jul 12, 2024

Description

When attempting to use this command to clear up errant topo data, it was realized that the help output for the flag was unclear and misleading. I've tried to make the help text clear based on following the code to see what the flags actually do.

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

Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link
Contributor

vitess-bot bot commented Jul 12, 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 Jul 12, 2024
@mattlord mattlord requested a review from deepthi July 12, 2024 22:08
@github-actions github-actions bot added this to the v21.0.0 milestone Jul 12, 2024
@deepthi deepthi 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 Jul 12, 2024
@deepthi
Copy link
Member

deepthi commented Jul 12, 2024

We do need to update website docs, but we can do that separately.

Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.67%. Comparing base (3d36adb) to head (1ff6aba).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #16376   +/-   ##
=======================================
  Coverage   68.66%   68.67%           
=======================================
  Files        1548     1548           
  Lines      199083   199083           
=======================================
+ Hits       136694   136711   +17     
+ Misses      62389    62372   -17     

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

@mattlord mattlord requested a review from rohit-nayak-ps July 12, 2024 22:54
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps left a comment

Choose a reason for hiding this comment

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

❤️

We should probably break this out into explicit commands, one for denied tables and another for query service: I will create an issue to track this.

@mattlord mattlord merged commit 8a59865 into vitessio:main Jul 15, 2024
126 checks passed
@mattlord mattlord deleted the set_shard_tablet_control branch July 15, 2024 12:22
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