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

Document/Expose "completion" command in ytt #478

Closed
2 tasks done
pivotaljohn opened this issue Aug 19, 2021 · 4 comments
Closed
2 tasks done

Document/Expose "completion" command in ytt #478

pivotaljohn opened this issue Aug 19, 2021 · 4 comments
Assignees
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request priority/important-soon Must be staffed and worked on currently or soon.

Comments

@pivotaljohn
Copy link
Contributor

pivotaljohn commented Aug 19, 2021

Cobra 1.2.0 introduced a feature by which the library automatically includes a shell completion command (for bash, fish, powershell, and z-shell). docs

Dependabot generated a PR for the upgrade: #451

When that PR is merged, the feature is available: this new command (i.e. completion) is automatically added:

$ ./ytt --help
ytt performs YAML templating.

Docs: https://carvel.dev/ytt/docs/latest/
Docs for data values: https://carvel.dev/ytt/docs/latest/ytt-data-values/

Usage:
  ytt [flags]
  ytt [command]

Available Commands:
  completion  generate the autocompletion script for the specified shell
  fmt         Format YAML templates
  help        Help about any command
...

👍🏻

To maximize the value the feature provides, we need to do a little work to let users know it is there:

  • include this new feature in our own release notes.
  • where we describe how to install ytt, mention this feature (point users to the help text: ytt completion help)
@pivotaljohn pivotaljohn added enhancement This issue is a feature request carvel triage This issue has not yet been triaged for relevance and removed carvel triage This issue has not yet been triaged for relevance labels Aug 19, 2021
@pivotaljohn
Copy link
Contributor Author

Removed "carvel triage"; we're definitely doing this work.

@aaronshurley aaronshurley added carvel accepted This issue should be considered for future work and that the triage process has been completed priority/important-soon Must be staffed and worked on currently or soon. labels Aug 20, 2021
@aaronshurley
Copy link
Contributor

Categorizing this as important-soon since we think that has a high ROI (little effort, high return).

@cari-lynn
Copy link
Contributor

One suggestion for the docs is to include that ytt completion zsh --help tell you the exact command to run. It was a bit confusing to me at first where to send the output of the command.

@gcheadle-vmware gcheadle-vmware self-assigned this Oct 11, 2021
@pivotaljohn
Copy link
Contributor Author

Completed by:

  • vmware-tanzu/carvel#279

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request priority/important-soon Must be staffed and worked on currently or soon.
Projects
None yet
Development

No branches or pull requests

4 participants