-
Notifications
You must be signed in to change notification settings - Fork 250
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
Add params description to describe commands #930
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will throw off the alignment of DEFAULT VALUE
values unfortunately. An example is shown below:
./tkn t desc build-docker-image-from-git-source -n lab-tekton-fundamentals-w01-s003
Name: build-docker-image-from-git-source
Namespace: lab-tekton-fundamentals-w01-s003
📨 Input Resources
NAME TYPE
∙ docker-source git
📡 Output Resources
NAME TYPE
∙ builtImage image
⚓ Params
NAME TYPE DESCRIPTION DEFAULT VALUE
∙ pathToDockerfile string The path to the dockerfile to build /workspace/docker-source/Dockerfile
∙ pathToContext string The build context used by Kaniko
(https://github.com/GoogleContainerTools/kaniko#kaniko-build-contexts)
/workspace/docker-source
🦶 Steps
∙ build-and-push
🗂 Taskruns
No taskruns
We would need some kind of character limit for descriptions, which I believe we do for some list commands if you wanted an example:
Line 132 in fde6491
"formatDesc": formatted.FormatDesc, |
cli/pkg/formatted/description.go
Line 19 in fde6491
func FormatDesc(desc string) string { |
Modified Thank you |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/meow
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: piyush-garg, vdemeester 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 |
Issue #929
Changes
Add params
Description
to describe subcommandsSubmitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
make check
make generated
See the contribution guide
for more details.
Release Notes