feat: shp buildrun gather subcommand to extract the details of the failed BuildRun by kaizakin · Pull Request #380 · shipwright-io/cli

kaizakin · 2026-03-21T22:26:27Z

Changes

added dynamic client support in params to fetch taskrun objects
added buildrun gather command that collects buildrun taskrun pod Objects and individual pod logs
--output flag determines the output location, default value is . currect directory.
--archive flag determines the output to be compressed as .tar.gz

Edit:

gather now supports PipelineRun executor as well
added options helper for dynamicClient and extended WithClientset NewParamsForTest to support dynamicClient
added unit tests

Fixes #250

Type of PR

/kind feature

Submitter Checklist

Includes tests if functionality changed/was added
Includes docs if changes are user-facing
Kind label has been set
Release notes block has been filled in, or marked NONE

TaskRun

2026-03-22.20-23-03.mp4

PipelineRun

2026-03-31.02-28-01.mp4

Release Notes

Add "shp buildrun gather" subcommand

openshift-ci · 2026-03-21T22:26:33Z

@kaizakin: The label(s) kind/your-label-here cannot be applied, because the repository doesn't have them.

Details

In response to this:

Changes

Fixes #250

Related Issue

Fixes #

Type of PR

/kind your-label-here

Submitter Checklist

Includes tests if functionality changed/was added

Includes docs if changes are user-facing

Kind label has been set

Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes
your release note here

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-sigs/prow repository.

openshift-ci · 2026-03-21T22:26:37Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign saschaschwarze0 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

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

Copilot

Pull request overview

Adds a new shp buildrun gather subcommand to collect BuildRun diagnostics (BuildRun/TaskRun/Pod objects + pod logs) into a directory or .tar.gz archive, to help debug failed BuildRuns (Fixes #250).

Changes:

Add a dynamic.Interface client to CLI params for fetching Tekton objects.
Introduce shp buildrun gather subcommand with --output and --archive flags to export YAMLs and logs.
Add generated CLI docs for the new subcommand and link it from shp buildrun docs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
pkg/shp/params/params.go	Adds dynamic client support for retrieving Tekton resources (TaskRuns).
pkg/shp/cmd/buildrun/gather.go	Implements the new `gather` subcommand, YAML/log collection, and optional tar.gz archiving.
pkg/shp/cmd/buildrun/buildrun.go	Registers `gather` under the `buildrun` command group.
docs/shp_buildrun_gather.md	Adds generated documentation for `shp buildrun gather`.
docs/shp_buildrun.md	Links the new `gather` subcommand in the BuildRun command index.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/shp_buildrun_gather.md

pkg/shp/params/params.go

pkg/shp/cmd/buildrun/gather.go

IrvingMg

Thanks for the PR @kaizakin!

I have a few suggestions for the first pass:

Please address Copilot’s review comments.
Fix the linter issues reported by CI.
Feel free to squash the commits as well.

Regarding your questions:

IIUC, supporting PipelineRun would add more complexity. So, in my opinion, it would be better to keep this PR focused on BuildRun, but I’d like to hear others’ opinions.
It would be nice to have unit tests, at least for basic scenarios.

kaizakin · 2026-03-31T15:58:56Z

requesting review @IrvingMg

pkg/shp/params/params.go

pkg/shp/cmd/buildrun/gather_test.go

pkg/shp/params/params.go

Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>

kaizakin · 2026-04-01T19:05:23Z

Thanks for the review @IrvingMg
suggested changes has been made 😁

IrvingMg · 2026-04-08T14:06:17Z

pkg/shp/cmd/buildrun/gather.go

+			return err
+		}
+
+		for _, container := range append(pod.Spec.InitContainers, pod.Spec.Containers...) {


Looks like this block can be commonized since it’s duplicated in gatherPipelineRunExecutor. Please also check if there’s any other duplication we can commonize.

IrvingMg · 2026-04-08T14:14:26Z

pkg/shp/cmd/buildrun/gather.go

+
+// Validate validates data input by user
+func (c *GatherCommand) Validate() error {
+	if c.name == "" {


Don’t we need some naming format? It looks like we currently support any non-whitespace string. This would likely fail on the server side at some point, but we could validate it earlier. WDYT?

IrvingMg · 2026-04-08T14:20:03Z

pkg/shp/cmd/buildrun/gather.go

+func resolvePodForTaskRun(ctx context.Context, client kubernetes.Interface, namespace string, taskRunName string, podName string) (*corev1.Pod, error) {
+	if podName != "" {
+		pod, err := client.CoreV1().Pods(namespace).Get(ctx, podName, metav1.GetOptions{})
+		switch {


Do we really need this switch here?

IrvingMg · 2026-04-08T14:53:06Z

pkg/shp/cmd/buildrun/gather.go

+	defer file.Close()
+
+	gzipWriter := gzip.NewWriter(file)
+	defer gzipWriter.Close()


I think we need to revisit the error handling in this function. For example,here it looks like if something fails, we could end up with a corrupted archive, so we might want to clean it up instead. Please double-check if the error handling is correct here.

pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 21, 2026

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note labels Mar 21, 2026

shipwright-ci-bot added this to Issues Mar 21, 2026

pull-request-size bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 22, 2026

kaizakin changed the title ~~Feat: add shp buildrun gather subcommand~~ feat: shp buildrun gather subcommand to extract the details of the failed BuildRun Mar 22, 2026

kaizakin force-pushed the feat/shp-gather branch from c761cbd to 8307693 Compare March 22, 2026 16:03

kaizakin marked this pull request as ready for review March 22, 2026 16:03

Copilot AI review requested due to automatic review settings March 22, 2026 16:03

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 22, 2026

openshift-ci bot requested review from HeavyWombat and qu1queee March 22, 2026 16:04

Copilot started reviewing on behalf of kaizakin March 22, 2026 16:04 View session

Copilot AI reviewed Mar 22, 2026

View reviewed changes

IrvingMg reviewed Mar 23, 2026

View reviewed changes

kaizakin force-pushed the feat/shp-gather branch from 8307693 to 41b15f6 Compare March 26, 2026 19:37

pull-request-size bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 26, 2026

kaizakin force-pushed the feat/shp-gather branch from 41b15f6 to dbc1236 Compare March 27, 2026 21:25

IrvingMg suggested changes Apr 1, 2026

View reviewed changes

pkg/shp/params/params.go Outdated Show resolved Hide resolved

pkg/shp/cmd/buildrun/gather_test.go Outdated Show resolved Hide resolved

pkg/shp/params/params.go Outdated Show resolved Hide resolved

kaizakin added 3 commits April 1, 2026 23:56

add dynamic clientset to Params and tests

31fc36f

Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>

feat: gather command to fetch failed buildrun diagnostics

164a614

Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>

doc: add shp buildrun gather command documentation

f588ccf

Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>

kaizakin force-pushed the feat/shp-gather branch from f89a76b to b14b390 Compare April 1, 2026 18:28

test: add tests for shp buildrun gather subcommand

d3e65e2

Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>

kaizakin force-pushed the feat/shp-gather branch from b14b390 to d3e65e2 Compare April 1, 2026 18:29

IrvingMg reviewed Apr 8, 2026

View reviewed changes

Conversation

kaizakin commented Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Type of PR

Submitter Checklist

TaskRun

PipelineRun

Release Notes

Uh oh!

openshift-ci bot commented Mar 21, 2026

Changes

Related Issue

Type of PR

Submitter Checklist

Release Notes

Uh oh!

openshift-ci bot commented Mar 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IrvingMg left a comment

Choose a reason for hiding this comment

Uh oh!

kaizakin commented Mar 31, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kaizakin commented Apr 1, 2026

Uh oh!

IrvingMg Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

IrvingMg Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

IrvingMg Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

IrvingMg Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kaizakin commented Mar 21, 2026 •

edited

Loading