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.

Sign up for GitHub

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

Jump to bottom

Add descriptions to custom completions (part 1) #9243

Merged
merged 6 commits into from Feb 24, 2021
Merged

Add descriptions to custom completions (part 1) #9243

merged 6 commits into from Feb 24, 2021

Commits on Feb 24, 2021

  1. feat(comp): Add descriptions for release name comp 

    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>
    @marckhouzam
    marckhouzam committed Feb 24, 2021
    Configuration menu
    Copy the full SHA
    a6b2834 View commit details
    Browse the repository at this point in the history

  2. feat(comp): Add descriptions for plugin completion 

    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>
    @marckhouzam
    marckhouzam committed Feb 24, 2021
    Configuration menu
    Copy the full SHA
    b0d567a View commit details
    Browse the repository at this point in the history

  3. feat(comp): Add descriptions for kube-context comp 

    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>
    @marckhouzam
    marckhouzam committed Feb 24, 2021
    Configuration menu
    Copy the full SHA
    7dee24d View commit details
    Browse the repository at this point in the history

  4. feat(comp): Add descriptions for revision comp 

    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>
    @marckhouzam
    marckhouzam committed Feb 24, 2021
    Configuration menu
    Copy the full SHA
    9856f05 View commit details
    Browse the repository at this point in the history

  5. feat(comp): Add descriptions for --version comp 

    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>
    @marckhouzam
    marckhouzam committed Feb 24, 2021
    Configuration menu
    Copy the full SHA
    4307091 View commit details
    Browse the repository at this point in the history

  6. feat(comp): Add descriptions for output format 

    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
    marckhouzam committed Feb 24, 2021
    Configuration menu
    Copy the full SHA
    593b267 View commit details
    Browse the repository at this point in the history