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

Consistent Approach to Referring to Tekton Resources Through CLI #124

Closed
danielhelfand opened this issue Oct 22, 2020 · 0 comments · Fixed by #125
Closed

Consistent Approach to Referring to Tekton Resources Through CLI #124

danielhelfand opened this issue Oct 22, 2020 · 0 comments · Fixed by #125
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt.

Comments

@danielhelfand
Copy link
Member

As documented in tektoncd/cli#605, it would be nice if the hub cli followed a similar approach for referring to Tekton resources in docs/user facing messages. To address this for hub, I believe all that would need to happen is to update the usage for commands:

Capitalize pipeline/task under Available commands for hub get -h:

Get resource manifest by its name, kind, catalog, and version

Usage:
tkn hub get [flags]
  tkn hub get [command]

Available Commands:
  pipeline    Get Pipeline by name, catalog and version
  task        Get Task by name, catalog and version

Flags:
      --from string      Name of Catalog to which resource belongs to. (default "tekton")
  -h, --help             help for get
      --version string   Version of Resource

Global Flags:
      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")

Use "tkn hub get [command] --help" for more information about a command.

Capitalize pipeline/task under Available commands for hub get task -h and hub get pipeline -h for description/examples:

Task

Get Task by name, catalog and version

Usage:
tkn hub get task [flags]

Examples:
  
Get a Task of name 'foo':

    tkn hub get task foo

or

Get a Task of name 'foo' of version '0.3':

    tkn hub get task foo --version 0.3


Flags:
  -h, --help   help for task

Global Flags:
      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
      --from string         Name of Catalog to which resource belongs to. (default "tekton")
      --version string      Version of Resource

Pipeline

Get Pipeline by name, catalog and version

Usage:
tkn hub get pipeline [flags]

Examples:
  
Get a Pipeline of name 'foo':

    tkn hub get pipeline foo

or

Get a Pipeline of name 'foo' of version '0.3':

    tkn hub get pipeline foo --version 0.3


Flags:
  -h, --help   help for pipeline

Global Flags:
      --api-server string   Hub API Server URL (default "https://api.hub.tekton.dev")
      --from string         Name of Catalog to which resource belongs to. (default "tekton")
      --version string      Version of Resource

/kind cleanup

@tekton-robot tekton-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Oct 22, 2020
sm43 pushed a commit to sm43/tektoncd-hub that referenced this issue Oct 23, 2020
…n Resources

This updates cmd examples to have Tekton Resource with first letter capital
in doc to follow similar approach as followed in tkn CLI.

Closes: tektoncd#124

Signed-off-by: Shivam Mukhade <smukhade@redhat.com>
sm43 pushed a commit to sm43/tektoncd-hub that referenced this issue Oct 23, 2020
This updates cmd examples to have Tekton Resource with first letter capital
in doc to follow similar approach as followed in tkn CLI.

Closes: tektoncd#124

Signed-off-by: Shivam Mukhade <smukhade@redhat.com>
sm43 pushed a commit to sm43/tektoncd-hub that referenced this issue Oct 27, 2020
This updates cmd examples to have Tekton Resource with first letter capital
in doc to follow similar approach as followed in tkn CLI.

Closes: tektoncd#124

Signed-off-by: Shivam Mukhade <smukhade@redhat.com>
tekton-robot pushed a commit that referenced this issue Oct 27, 2020
This updates cmd examples to have Tekton Resource with first letter capital
in doc to follow similar approach as followed in tkn CLI.

Closes: #124

Signed-off-by: Shivam Mukhade <smukhade@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants