Skip to content

feat: add structured JSON/YAML output for delete command #3318

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

Merged
tekton-robot merged 1 commit into from
Oct 8, 2026
Merged

feat: add structured JSON/YAML output for delete command #3318

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
21 changes: 14 additions & 7 deletions docs/cmd/tkn_clustertriggerbinding_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,24 @@ or

tkn ctb rm foo bar

Delete a ClusterTriggerBinding and print the result as JSON:

tkn clustertriggerbinding delete foo -o json

Delete a ClusterTriggerBinding and print the result as YAML:

tkn clustertriggerbinding delete foo -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all ClusterTriggerBindings (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--all Delete all ClusterTriggerBindings (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
```

### Options inherited from parent commands
Expand Down
15 changes: 10 additions & 5 deletions docs/cmd/tkn_customrun_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,20 @@ or

tkn cr rm foo -n bar

Delete a CustomRun and print the result as JSON:

tkn customrun delete foo -n bar -o json

Delete a CustomRun and print the result as YAML:

tkn customrun delete foo -n bar -o yaml


### Options

```
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
-h, --help help for delete
-o, --output string Output format. One of: json|yaml
```

### Options inherited from parent commands
Expand Down
21 changes: 14 additions & 7 deletions docs/cmd/tkn_eventlistener_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,24 @@ or

tkn el rm foo bar -n quux

Delete an EventListener and print the result as JSON:

tkn eventlistener delete foo -n quux -o json

Delete an EventListener and print the result as YAML:

tkn eventlistener delete foo -n quux -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all EventListeners in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--all Delete all EventListeners in a namespace (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
```

### Options inherited from parent commands
Expand Down
23 changes: 15 additions & 8 deletions docs/cmd/tkn_pipeline_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,25 @@ or

tkn p rm foo bar -n quux

Delete a Pipeline and print the result as JSON:

tkn pipeline delete foo -n quux -o json

Delete a Pipeline and print the result as YAML:

tkn pipeline delete foo -n quux -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all Pipelines in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--prs Whether to delete Pipeline(s) and related resources (PipelineRuns) (default: false)
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--all Delete all Pipelines in a namespace (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
--prs Whether to delete Pipeline(s) and related resources (PipelineRuns) (default: false)
```

### Options inherited from parent commands
Expand Down
31 changes: 19 additions & 12 deletions docs/cmd/tkn_pipelinerun_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,29 @@ or

tkn pr rm foo bar -n quux

Delete a PipelineRun and print the result as JSON:

tkn pipelinerun delete foo -n quux -o json

Delete a PipelineRun and print the result as YAML:

tkn pipelinerun delete foo -n quux -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all PipelineRuns in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-i, --ignore-running ignore running PipelineRun (default true)
--keep int Keep n most recent number of PipelineRuns
--keep-since int When deleting all PipelineRuns keep the ones that has been completed since n minutes
--label string A selector (label query) to filter on when running with --all, supports '=', '==', and '!='
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
-p, --pipeline string The name of a Pipeline whose PipelineRuns should be deleted (does not delete the Pipeline)
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--all Delete all PipelineRuns in a namespace (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-i, --ignore-running ignore running PipelineRun (default true)
--keep int Keep n most recent number of PipelineRuns
--keep-since int When deleting all PipelineRuns keep the ones that has been completed since n minutes
--label string A selector (label query) to filter on when running with --all, supports '=', '==', and '!='
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
-p, --pipeline string The name of a Pipeline whose PipelineRuns should be deleted (does not delete the Pipeline)
```

### Options inherited from parent commands
Expand Down
23 changes: 15 additions & 8 deletions docs/cmd/tkn_task_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,25 @@ or

tkn t rm foo bar -n quux

Delete a Task and print the result as JSON:

tkn task delete foo -n quux -o json

Delete a Task and print the result as YAML:

tkn task delete foo -n quux -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all Tasks in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--trs Whether to delete Task(s) and related resources (TaskRuns) (default: false)
--all Delete all Tasks in a namespace (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
--trs Whether to delete Task(s) and related resources (TaskRuns) (default: false)
```

### Options inherited from parent commands
Expand Down
21 changes: 14 additions & 7 deletions docs/cmd/tkn_triggerbinding_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,24 @@ or

tkn tb rm foo bar -n quux

Delete a TriggerBinding and print the result as JSON:

tkn triggerbinding delete foo -n quux -o json

Delete a TriggerBinding and print the result as YAML:

tkn triggerbinding delete foo -n quux -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all TriggerBindings in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--all Delete all TriggerBindings in a namespace (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
```

### Options inherited from parent commands
Expand Down
21 changes: 14 additions & 7 deletions docs/cmd/tkn_triggertemplate_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,24 @@ or

tkn tt rm foo bar -n quux

Delete a TriggerTemplate and print the result as JSON:

tkn triggertemplate delete foo -n quux -o json

Delete a TriggerTemplate and print the result as YAML:

tkn triggertemplate delete foo -n quux -o yaml

Using -o json or -o yaml skips the confirmation prompt.


### Options

```
--all Delete all TriggerTemplates in a namespace (default: false)
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
--show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
--all Delete all TriggerTemplates in a namespace (default: false)
-f, --force Whether to force deletion (default: false)
-h, --help help for delete
-o, --output string Output format. One of: json|yaml. Skips the confirmation prompt
```

### Options inherited from parent commands
Expand Down
42 changes: 28 additions & 14 deletions docs/man/man1/tkn-clustertriggerbinding-delete.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ Delete ClusterTriggerBindings
\fB\-\-all\fP[=false]
Delete all ClusterTriggerBindings (default: false)

.PP
\fB\-\-allow\-missing\-template\-keys\fP[=true]
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

.PP
\fB\-f\fP, \fB\-\-force\fP[=false]
Whether to force deletion (default: false)
Expand All @@ -37,16 +33,7 @@ Delete ClusterTriggerBindings

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: (json, yaml, name, go\-template, go\-template\-file, template, templatefile, jsonpath, jsonpath\-as\-json, jsonpath\-file).

.PP
\fB\-\-show\-managed\-fields\fP[=false]
If true, keep the managedFields when printing objects in JSON or YAML format.

.PP
\fB\-\-template\fP=""
Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]].
Output format. One of: json|yaml. Skips the confirmation prompt


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down Expand Up @@ -88,6 +75,33 @@ tkn ctb rm foo bar
.fi
.RE

.PP
Delete a ClusterTriggerBinding and print the result as JSON:

.PP
.RS

.nf
tkn clustertriggerbinding delete foo \-o json

.fi
.RE

.PP
Delete a ClusterTriggerBinding and print the result as YAML:

.PP
.RS

.nf
tkn clustertriggerbinding delete foo \-o yaml

.fi
.RE

.PP
Using \-o json or \-o yaml skips the confirmation prompt.


.SH SEE ALSO
.PP
Expand Down
39 changes: 25 additions & 14 deletions docs/man/man1/tkn-customrun-delete.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,13 @@ Delete CustomRuns in a namespace


.SH OPTIONS
.PP
\fB\-\-allow\-missing\-template\-keys\fP[=true]
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for delete

.PP
\fB\-o\fP, \fB\-\-output\fP=""
Output format. One of: (json, yaml, name, go\-template, go\-template\-file, template, templatefile, jsonpath, jsonpath\-as\-json, jsonpath\-file).

.PP
\fB\-\-show\-managed\-fields\fP[=false]
If true, keep the managedFields when printing objects in JSON or YAML format.

.PP
\fB\-\-template\fP=""
Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [
\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]].
Output format. One of: json|yaml


.SH OPTIONS INHERITED FROM PARENT COMMANDS
Expand Down Expand Up @@ -84,6 +71,30 @@ tkn cr rm foo \-n bar
.fi
.RE

.PP
Delete a CustomRun and print the result as JSON:

.PP
.RS

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

.fi
.RE

.PP
Delete a CustomRun and print the result as YAML:

.PP
.RS

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

.fi
.RE


.SH SEE ALSO
.PP
Expand Down
Loading
Loading