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

pkg/cli/init.go: make flag help consistent #1564

Merged
merged 1 commit into from
Jun 18, 2020

Conversation

estroz
Copy link
Contributor

@estroz estroz commented Jun 17, 2020

Any flag help printed should be consistent between invocations so generated CLI docs (cobra has a nice API for this) don't break randomly. Also remove duplicate plugin keys from flag help.

/cc @camilamacedo86 @DirectXMan12

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 17, 2020
@estroz estroz changed the title pkg/cli/init.go: sort available plugins and project versions in flag help pkg/cli/init.go: make flag help consistent Jun 17, 2020
@estroz
Copy link
Contributor Author

estroz commented Jun 17, 2020

/test pull-kubebuilder-e2e-k8s-1-17-0

for _, versionedPlugins := range c.pluginsFromOptions {
for _, p := range versionedPlugins {
// Only return non-deprecated plugins.
if _, isDeprecated := p.(plugin.Deprecated); !isDeprecated {
pluginKeys = append(pluginKeys, strconv.Quote(plugin.KeyFor(p)))
keySet[plugin.KeyFor(p)] = struct{}{}

Choose a reason for hiding this comment

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

I can see that we're doing sort.Strings(pluginKeys) which orders the plugin keys but any reason for building the keySet here and then appending the keys to pluginKeys?
pluginKeys = append(pluginKeys, strconv.Quote(plugin.KeyFor(p))) isn't too unreadable imo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

c.pluginsFromOptions are indexed by project version, so two versionedPlugins slices can be intersecting sets if one plugin supports two project versions (go/v2 supports project versions 2 and 3-alpha).

Choose a reason for hiding this comment

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

Ah, double counting. Gotcha.

@estroz
Copy link
Contributor Author

estroz commented Jun 18, 2020

/test pull-kubebuilder-e2e-k8s-1-15-3

@estroz
Copy link
Contributor Author

estroz commented Jun 18, 2020

/test pull-kubebuilder-e2e-k8s-1-14-1

Copy link

@hasbro17 hasbro17 left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 18, 2020
@estroz
Copy link
Contributor Author

estroz commented Jun 18, 2020

/test pull-kubebuilder-e2e-k8s-1-14-1

Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

/approved

@camilamacedo86
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, estroz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 18, 2020
@k8s-ci-robot k8s-ci-robot merged commit 36aa113 into kubernetes-sigs:master Jun 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants