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

Hide the --local flag of the "plugin install" cmd #153

Merged
merged 1 commit into from
Apr 3, 2023

Conversation

marckhouzam
Copy link
Contributor

What this PR does / why we need it

Hide the --local flag of the "plugin install" cmd to avoid giving the impression that it can be used in production.
The plugin install --local form should only be used when doing local testing while developing a plugin and it should be used implicitly through make plugin-install-local that is introduced in #139 .

Which issue(s) this PR fixes

Fixes #152

Describe testing done for PR

# Notice there is no --local flag shown
$ tz plugin install -h

# Notice there is no shell completion of the --local flag
$ tz plugin install builder --loc<TAB>

# Notice the --local flag still works even though it is hidden
$ tz plugin install builder --local ./artifacts/plugins/darwin/amd64/
[i] Installing plugin 'builder:v0.1.0-dev-23-g23f63f168' with target 'global'
[ok] successfully installed 'builder' plugin

Release note

The "tanzu plugin install --local" form is no longer to be used in production.  The "--local" flag is therefore hidden.

Additional information

Special notes for your reviewer

@marckhouzam marckhouzam requested a review from a team as a code owner April 3, 2023 00:02
Fix vmware-tanzu#152

Signed-off-by: Marc Khouzam <kmarc@vmware.com>
Copy link
Contributor

@anujc25 anujc25 left a comment

Choose a reason for hiding this comment

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

LGTM

@marckhouzam marckhouzam merged commit ce67ec5 into vmware-tanzu:main Apr 3, 2023
@marckhouzam marckhouzam deleted the feat/hideLocal branch April 3, 2023 12:20
@vuil vuil added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process label Apr 7, 2023
@marckhouzam marckhouzam added this to the v0.90.0 milestone Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-not-required kind/cleanup Categorizes issue or PR as related to cleaning up code, process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The --local flag should not be used in production to install plugins
4 participants