Add descriptions to custom completions (part 1) #9243
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
helm-bot
added
the
size/L
marckhouzam
force-pushed
the
feat/compDescriptions
branch
2 times, most recently
from
6cc8c6a
to
1d3d961
Compare
Ref: HIP 0008 When completing a release name, extra information will be shown for shells that support completions (fish, zsh). For example, if I have two releases: "nginx" and "nginx2", completion would yield: $ helm history n<TAB> nginx -- nginx-6.0.2 -> deployed nginx2 -- nginx-ingress-1.41.2 -> deployed Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
Ref: HIP 0008 When completing a plugin name, extra information will be shown for shells that support completions (fish, zsh). For example: $ helm plugin uninstall <TAB> 2to3 -- migrate and cleanup Helm v2 configuration and releases in-place to Helm v3 diff -- Preview helm upgrade changes as a diff fullstatus -- provide status of resources part of the release github -- Install or upgrade Helm charts from GitHub repos Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
Ref: HIP 0008 When completing a kube-context, extra information will be shown for shells that support completions (fish, zsh). For example: $ helm --kube-context <TAB> acc -- accept default -- k3d-k3s-default lab -- lab lab2 -- cluster.local Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
Ref: HIP 0008 When completing a revision, extra information will be shown for shells that support completions (fish, zsh). For example: $ helm get manifest nginx --revision <TAB> 1 -- App: 1.19.1, Chart: nginx-6.0.2 2 -- App: v0.34.1, Chart: nginx-ingress-1.41.2 Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
Ref: HIP 0008 When completing a version, extra information will be shown for shells that support completions (fish, zsh). For example: $ helm upgrade nginx stable/grafana --version <TAB> 0.8.4 -- Created: March 30, 2018 0.8.5 -- App: 5.0.4, Created: April 10, 2018 1.0.0 -- App: 5.0.4, Created: April 11, 2018 (deprecated) 1.10.0 -- App: 5.1.2, Created: June 1, 2018 Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
Ref: HIP 0008 When completing output formats, extra information will be shown for shells that support completions (fish, zsh). For example: $ helm status -o <TAB> json -- Output result in JSON format table -- Output result in human-readable format yaml -- Output result in YAML format Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
marckhouzam
force-pushed
the
feat/compDescriptions
branch
from
1d3d961
to
593b267
Compare
|
The force push was simply a rebase to resolve conflicts. |
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 this PR does / why we need it:
This is part 1 of the implementation of HIP 008: https://github.com/helm/community/blob/master/hips/hip-0008.md
For the
zshandfishshells, this PR adds descriptions to Helm's custom completions to make them more informative to the the user. Specifically:Special notes for your reviewer:
This is part 1 of HIP 0008 because the remaining aspects require a little more discussion, so I thought I would do them in a separate PR:
<repo>-charts.txtfile, which currently does not contain enough information to provide a description for chart nameshelm show all bitna[TAB]due to a couple of bugs in CobraIf applicable: