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

Correct WriteTopologyPath args to match help text #17735

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Feb 11, 2025

Description

The new WriteTopologyPath command recently added in #17442 had a mismatch between the help output and the actual behavior:

❯ vtctldclient WriteTopologyPath --help | head
Copies a local file to the topology server at the given path.

Usage:
  vtctldclient WriteTopologyPath --server=local <path> <file>

Flags:
      --cell string   Topology server cell to copy the file to. (default "global")
  -h, --help          help for WriteTopologyPath

Global Flags:

❯ vtctldclient --server=internal WriteTopologyPath /global/keyspaces/customer/Keyspace /tmp/foo.com
E0211 10:34:19.494447   46753 main.go:60] failed to read file /global/keyspaces/customer/Keyspace: open /global/keyspaces/customer/Keyspace: no such file or directory

This follow-up PR corrects this discrepancy.

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

Copy link
Contributor

vitess-bot bot commented Feb 11, 2025

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 Feb 11, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 11, 2025
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord force-pushed the write_topo_path_help branch from 49155b3 to d23de58 Compare February 11, 2025 03:47
@mattlord mattlord changed the title Correct WriteTopologyPath help output Correct WriteTopologyPath args to match help text Feb 11, 2025
@mattlord mattlord added Type: Bug Component: vtctldclient and removed NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Feb 11, 2025
Copy link

codecov bot commented Feb 11, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.95%. Comparing base (b567098) to head (d23de58).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
go/cmd/vtctldclient/command/topology.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17735   +/-   ##
=======================================
  Coverage   67.95%   67.95%           
=======================================
  Files        1586     1586           
  Lines      255173   255195   +22     
=======================================
+ Hits       173398   173419   +21     
- Misses      81775    81776    +1     

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

@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 labels Feb 11, 2025
@mattlord mattlord marked this pull request as ready for review February 11, 2025 15:37
@mattlord mattlord merged commit 2b21fb4 into vitessio:main Feb 11, 2025
105 of 109 checks passed
@mattlord mattlord deleted the write_topo_path_help branch February 11, 2025 16:11
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