Enable shell completion descriptions for bash #113636
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind feature
What this PR does / why we need it:
This PR enables descriptions for
kubectl
shell completion for the bash shell, just like is already supported forzsh
,fish
andpowershell
.This support is transparently provided by Cobra. It was turned off for
kubetl
because of a bug with certain bash menu options which has been fixed by Cobra 1.3.0 which has been used bykubectl
for a while now.Before the PR:
With the PR:
Special notes for your reviewer:
Helm has been using this feature without issue since Helm 3.7.0 which has been released September 15, 2021.
However, in a possibly overly cautious approach, helm allows users to choose to disable completion descriptions for bash and all other shells as well. As for
kubectl
, it currently enables shell descriptions all the time forzsh
,powershell
andfish
, so this PR does the same forbash
.Does this PR introduce a user-facing change?
cc @brianpursley