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

Only use persistent flags if appropriate #5423

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Jan 9, 2025

Description

These flags are used for shared functionality based on Cobra's "persistent" functions. In k0s, however, the distinction was never that clear. Persistent flags were mostly used by accident, sometimes to share flag definitions between subcommands, even if the persistent functions didn't use those flags.

Identify most (all?) of these cases and use flags instead of persistent flags. Deprecate and hide the unused persistent flags, so that they can eventually be removed.

Also remove the cwd prefixing for the restored config file in k0s restore. Relative paths are automatically resolved based on the current working directory. No need to do this manually.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

twz123 added 2 commits January 9, 2025 11:40
Relative paths are automatically resolved based on the current working
directory. No need to do this manually.

Signed-off-by: Tom Wieczorek <[email protected]>
These flags are used for shared functionality based on Cobra's
"persistent" functions. In k0s, however, the distinction was never that
clear. Persistent flags were mostly used by accident, sometimes to share
flag definitions between subcommands, even if the persistent functions
didn't use those flags.

Identify most (all?) of these cases and use flags instead of persistent
flags. Deprecate and hide the unused persistent flags, so that they can
eventually be removed.

Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 marked this pull request as ready for review January 9, 2025 15:10
@twz123 twz123 requested review from a team as code owners January 9, 2025 15:10
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.

1 participant