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

Add params description to describe commands #930

Merged
merged 1 commit into from
Apr 24, 2020

Conversation

savitaashture
Copy link
Contributor

@savitaashture savitaashture commented Apr 22, 2020

Issue #929

Changes

Add params Description to describe subcommands

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Run the code checkers with make check
  • Regenerate the manpages, docs and go formatting with make generated
  • Commit messages follow commit message best practices

See the contribution guide
for more details.

Release Notes

release-note

@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 22, 2020
Copy link
Member

@danielhelfand danielhelfand left a 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:

"formatDesc": formatted.FormatDesc,

func FormatDesc(desc string) string {

@savitaashture
Copy link
Contributor Author

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:

"formatDesc": formatted.FormatDesc,

func FormatDesc(desc string) string {

Modified Thank you

Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/meow

@tekton-robot
Copy link
Contributor

@vdemeester: cat image

In response to this:

/meow

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.

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 24, 2020
Copy link
Contributor

@piyush-garg piyush-garg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 24, 2020
@tekton-robot
Copy link
Contributor

[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:
  • OWNERS [piyush-garg,vdemeester]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot merged commit 0f9bfdd into tektoncd:master Apr 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants