Repository navigation
docs: add JSON/YAML output examples to list command help - #3269
Merged
tekton-robot merged 1 commit intoSep 16, 2026
Merged
Conversation
tekton-robot
added
the
release-note-none
tekton-robot
added
the
size/L
Add `-o json` and `-o yaml` examples to the help text for list commands across core Tekton resources (pipeline, task, pipelinerun, taskrun, customrun) and Triggers resources (eventlistener, triggerbinding, clustertriggerbinding, triggertemplate). Signed-off-by: Arvind <arvkrish@redhat.com>
arvindk-softwaredev
force-pushed
the
doc/list-command-examples
branch
from
September 16, 2026 12:41
d5937a1 to
9b76913
Compare
Contributor
Author
|
/retest |
1 similar comment
Member
|
/retest |
There was a problem hiding this comment.
🟡 Changes recommended
Clarify that JSON/YAML output is a Kubernetes list resource containing an items field.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds JSON/YAML output examples to nine Tekton and Triggers list-command help texts, with regenerated documentation.
Changes:
- Adds
-o jsonand-o yamlexamples. - Regenerates Markdown command references and manpages.
File summaries
| File | Reviewed change |
|---|---|
pkg/cmd/triggertemplate/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/triggerbinding/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/taskrun/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/task/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/pipelinerun/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/pipeline/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/eventlistener/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/customrun/list.go |
Adds JSON/YAML list-output examples. |
pkg/cmd/clustertriggerbinding/list.go |
Adds JSON/YAML list-output examples. |
docs/man/man1/tkn-triggertemplate-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-triggerbinding-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-taskrun-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-task-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-pipelinerun-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-pipeline-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-eventlistener-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-customrun-list.1 |
Regenerated command documentation. |
docs/man/man1/tkn-clustertriggerbinding-list.1 |
Regenerated command documentation. |
docs/cmd/tkn_triggertemplate_list.md |
Regenerated command documentation. |
docs/cmd/tkn_triggerbinding_list.md |
Regenerated command documentation. |
docs/cmd/tkn_taskrun_list.md |
Regenerated command documentation. |
docs/cmd/tkn_task_list.md |
Regenerated command documentation. |
docs/cmd/tkn_pipelinerun_list.md |
Regenerated command documentation. |
docs/cmd/tkn_pipeline_list.md |
Regenerated command documentation. |
docs/cmd/tkn_eventlistener_list.md |
Regenerated command documentation. |
docs/cmd/tkn_customrun_list.md |
Regenerated command documentation. |
docs/cmd/tkn_clustertriggerbinding_list.md |
Regenerated command documentation. |
Review details
- Files reviewed: 27/27 changed files
- Comments generated: 9
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+51
to
+55
| List ClusterTriggerBindings as a JSON array: | ||
|
|
||
| tkn clustertriggerbinding list -o json | ||
|
|
||
| List ClusterTriggerBindings as a YAML array: |
Comment on lines
+68
to
+72
| List CustomRuns as a JSON array: | ||
|
|
||
| tkn customrun list -o json | ||
|
|
||
| List CustomRuns as a YAML array: |
Comment on lines
+53
to
+57
| List EventListeners as a JSON array: | ||
|
|
||
| tkn eventlistener list -o json | ||
|
|
||
| List EventListeners as a YAML array: |
Comment on lines
+81
to
+85
| List Pipelines as a JSON array: | ||
|
|
||
| tkn pipeline list -o json | ||
|
|
||
| List Pipelines as a YAML array: |
Comment on lines
+70
to
+74
| List PipelineRuns as a JSON array: | ||
|
|
||
| tkn pipelinerun list -o json | ||
|
|
||
| List PipelineRuns as a YAML array: |
Comment on lines
+71
to
+75
| List Tasks as a JSON array: | ||
|
|
||
| tkn task list -o json | ||
|
|
||
| List Tasks as a YAML array: |
Comment on lines
+73
to
+77
| List TaskRuns as a JSON array: | ||
|
|
||
| tkn taskrun list -o json | ||
|
|
||
| List TaskRuns as a YAML array: |
Comment on lines
+52
to
+56
| List TriggerBindings as a JSON array: | ||
|
|
||
| tkn triggerbinding list -o json | ||
|
|
||
| List TriggerBindings as a YAML array: |
Comment on lines
+51
to
+55
| List TriggerTemplates as a JSON array: | ||
|
|
||
| tkn triggertemplate list -o json | ||
|
|
||
| List TriggerTemplates as a YAML array: |
divyansh42
approved these changes
Sep 16, 2026
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: divyansh42 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
Contributor
|
/lgtm |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #2850
Changes
Add
-o jsonand-o yamlexamples to the help text for list commands across core Tekton resources (pipeline, task, pipelinerun, taskrun, customrun) and Triggers resources (eventlistener, triggerbinding, clustertriggerbinding, triggertemplate).Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
make checkmake generatedSee the contribution guide
for more details.
Release Notes