Skip to content

feat: add structured JSON/YAML output for describe commands #3243

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

Draft
ankrsinha wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add structured JSON/YAML output for describe commands #3243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/cmd/tkn_clustertriggerbinding_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn ctb desc foo

Describe a ClusterTriggerBinding of name 'foo' in JSON format:

tkn clustertriggerbinding describe foo -o json

Describe a ClusterTriggerBinding of name 'foo' in YAML format:

tkn clustertriggerbinding describe foo -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_customrun_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn cr desc foo -n bar

Describe a CustomRun of name 'foo' in namespace 'bar' in JSON format:

tkn customrun describe foo -n bar -o json

Describe a CustomRun of name 'foo' in namespace 'bar' in YAML format:

tkn customrun describe foo -n bar -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_eventlistener_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn el desc foo -n bar

Describe an EventListener of name 'foo' in namespace 'bar' in JSON format:

tkn eventlistener describe foo -n bar -o json

Describe an EventListener of name 'foo' in namespace 'bar' in YAML format:

tkn eventlistener describe foo -n bar -o yaml


### Options

Expand Down
15 changes: 15 additions & 0 deletions docs/cmd/tkn_pipeline_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ tkn pipeline describe

Describes a Pipeline in a namespace

### Examples

Describe a Pipeline named 'foo' in namespace 'bar':

tkn pipeline describe foo -n bar

Describe a Pipeline as JSON:

tkn pipeline describe foo -o json

Describe a Pipeline as YAML:

tkn pipeline describe foo -o yaml


### Options

```
Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_pipelinerun_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn pr desc foo -n bar

Describe a PipelineRun of name 'foo' in namespace 'bar' in JSON format:

tkn pipelinerun describe foo -n bar -o json

Describe a PipelineRun of name 'foo' in namespace 'bar' in YAML format:

tkn pipelinerun describe foo -n bar -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_task_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn t desc foo -n bar

Describe a Task of name 'foo' in namespace 'bar' in JSON format:

tkn task describe foo -n bar -o json

Describe a Task of name 'foo' in namespace 'bar' in YAML format:

tkn task describe foo -n bar -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_taskrun_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn tr desc foo -n bar

Describe a TaskRun of name 'foo' in namespace 'bar' in JSON format:

tkn taskrun describe foo -n bar -o json

Describe a TaskRun of name 'foo' in namespace 'bar' in YAML format:

tkn taskrun describe foo -n bar -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_triggerbinding_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn tb desc foo -n bar

Describe a TriggerBinding of name 'foo' in namespace 'bar' in JSON format:

tkn triggerbinding describe foo -n bar -o json

Describe a TriggerBinding of name 'foo' in namespace 'bar' in YAML format:

tkn triggerbinding describe foo -n bar -o yaml


### Options

Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/tkn_triggertemplate_describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ or

tkn tt desc foo -n bar

Describe a TriggerTemplate of name 'foo' in namespace 'bar' in JSON format:

tkn triggertemplate describe foo -n bar -o json

Describe a TriggerTemplate of name 'foo' in namespace 'bar' in YAML format:

tkn triggertemplate describe foo -n bar -o yaml


### Options

Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-clustertriggerbinding-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,30 @@ tkn ctb desc foo
.fi
.RE

.PP
Describe a ClusterTriggerBinding of name 'foo' in JSON format:

.PP
.RS

.nf
tkn clustertriggerbinding describe foo \-o json

.fi
.RE

.PP
Describe a ClusterTriggerBinding of name 'foo' in YAML format:

.PP
.RS

.nf
tkn clustertriggerbinding describe foo \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-customrun-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,30 @@ tkn cr desc foo \-n bar
.fi
.RE

.PP
Describe a CustomRun of name 'foo' in namespace 'bar' in JSON format:

.PP
.RS

.nf
tkn customrun describe foo \-n bar \-o json

.fi
.RE

.PP
Describe a CustomRun of name 'foo' in namespace 'bar' in YAML format:

.PP
.RS

.nf
tkn customrun describe foo \-n bar \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-eventlistener-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,30 @@ or
.PP
tkn el desc foo \-n bar

.PP
Describe an EventListener of name 'foo' in namespace 'bar' in JSON format:

.PP
.RS

.nf
tkn eventlistener describe foo \-n bar \-o json

.fi
.RE

.PP
Describe an EventListener of name 'foo' in namespace 'bar' in YAML format:

.PP
.RS

.nf
tkn eventlistener describe foo \-n bar \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
38 changes: 38 additions & 0 deletions docs/man/man1/tkn-pipeline-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,44 @@ Describes a Pipeline in a namespace
disable coloring (default: false)


.SH EXAMPLE
.PP
Describe a Pipeline named 'foo' in namespace 'bar':

.PP
.RS

.nf
tkn pipeline describe foo \-n bar

.fi
.RE

.PP
Describe a Pipeline as JSON:

.PP
.RS

.nf
tkn pipeline describe foo \-o json

.fi
.RE

.PP
Describe a Pipeline as YAML:

.PP
.RS

.nf
tkn pipeline describe foo \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
\fBtkn\-pipeline(1)\fP
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-pipelinerun-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,30 @@ tkn pr desc foo \-n bar
.fi
.RE

.PP
Describe a PipelineRun of name 'foo' in namespace 'bar' in JSON format:

.PP
.RS

.nf
tkn pipelinerun describe foo \-n bar \-o json

.fi
.RE

.PP
Describe a PipelineRun of name 'foo' in namespace 'bar' in YAML format:

.PP
.RS

.nf
tkn pipelinerun describe foo \-n bar \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-task-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,30 @@ or
.PP
tkn t desc foo \-n bar

.PP
Describe a Task of name 'foo' in namespace 'bar' in JSON format:

.PP
.RS

.nf
tkn task describe foo \-n bar \-o json

.fi
.RE

.PP
Describe a Task of name 'foo' in namespace 'bar' in YAML format:

.PP
.RS

.nf
tkn task describe foo \-n bar \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
24 changes: 24 additions & 0 deletions docs/man/man1/tkn-taskrun-describe.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,30 @@ tkn tr desc foo \-n bar
.fi
.RE

.PP
Describe a TaskRun of name 'foo' in namespace 'bar' in JSON format:

.PP
.RS

.nf
tkn taskrun describe foo \-n bar \-o json

.fi
.RE

.PP
Describe a TaskRun of name 'foo' in namespace 'bar' in YAML format:

.PP
.RS

.nf
tkn taskrun describe foo \-n bar \-o yaml

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
Loading