Skip to content

Conversation

@mounicasruthi
Copy link
Collaborator

@mounicasruthi mounicasruthi commented Mar 17, 2025

Description

This PR is a part of an ongoing change to support the transition from underscores (_) to dashes (-) in flag naming conventions.

Flags Updated in This PR:
--topo-consul-lock-delay
--topo-consul-lock-session-checks
--topo-consul-lock-session-ttl
--topo-consul-watch-poll-duration
--topo-etcd-lease-ttl
--topo-etcd-tls-ca
--topo-etcd-tls-cert
--topo-etcd-tls-key
--topo-global-root
--topo-global-server-address
--topo-implementation
--topo-information-refresh-duration
--topo-read-concurrency
--topo-zk-auth-file
--topo-zk-base-timeout
--topo-zk-max-concurrency
--topo-zk-tls-ca
--topo-zk-tls-cert
--topo-zk-tls-key

Flag Count Before vs After:

Flags with _ Flags with -
Before 1484 576
After 1366 694

# of migrated flags: 118

Related Issue(s)

#17880

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

@mounicasruthi mounicasruthi added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: General Changes throughout the code base labels Mar 17, 2025
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 17, 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 Mar 17, 2025
@mounicasruthi mounicasruthi 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 17, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Mar 17, 2025
@codecov
Copy link

codecov bot commented Mar 17, 2025

Codecov Report

Attention: Patch coverage is 80.95238% with 8 lines in your changes missing coverage. Please review.

Please upload report for BASE (flags-refactor@c98bd37). Learn more about missing BASE report.

Files with missing lines Patch % Lines
go/vt/topo/zk2topo/zk_conn.go 66.66% 3 Missing ⚠️
go/vt/vttest/vtprocess.go 0.00% 3 Missing ⚠️
go/vt/topo/server.go 66.66% 2 Missing ⚠️
Additional details and impacted files
@@                Coverage Diff                @@
##             flags-refactor   #17975   +/-   ##
=================================================
  Coverage                  ?   67.56%           
=================================================
  Files                     ?     1598           
  Lines                     ?   259808           
  Branches                  ?        0           
=================================================
  Hits                      ?   175545           
  Misses                    ?    84263           
  Partials                  ?        0           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

vtbackup.proc.Args = append(vtbackup.proc.Args, k, v)
}

// vtbackup.proc = exec.Command(
Copy link
Member

Choose a reason for hiding this comment

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

We should remove these comments

@rohit-nayak-ps rohit-nayak-ps merged commit 0a9d1ee into vitessio:flags-refactor Mar 22, 2025
103 checks passed
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request Apr 3, 2025
Signed-off-by: mounicasruthi <[email protected]>
Signed-off-by: Mounica Sruthi <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Deepthi Sigireddi <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request May 20, 2025
Signed-off-by: mounicasruthi <[email protected]>
Signed-off-by: Mounica Sruthi <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Deepthi Sigireddi <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>
mounicasruthi added a commit to mounicasruthi/vitess that referenced this pull request May 20, 2025
Signed-off-by: mounicasruthi <[email protected]>
Signed-off-by: Mounica Sruthi <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
Co-authored-by: Deepthi Sigireddi <[email protected]>
Co-authored-by: Rohit Nayak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: General Changes throughout the code base Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants