add cli changes to move to v1beta1 #304

karanibm6 · 2025-03-24T06:28:31Z

Changes

Add code changes to move to v1beta1 from v1alpha1

Fixes #294

Submitter Checklist

Includes tests if functionality changed/was added
Includes docs if changes are user-facing
Set a kind label on this PR
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

Add code changes to move to v1beta1 from v1alpha1

HeavyWombat

Thanks for all the work. Nice. I just left some comments and questions after an initial pass.

HeavyWombat · 2025-03-24T13:48:53Z

docs/shp_build_create.md

+      --source-oci-artifact-image string         source oci artifact image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest
+      --source-oci-artifact-prune pruneOption    source oci artifact image prune option, either Never, or AfterPull (default Never)


Nit: I think I should try uppercase since it's an acronym.

Suggested change

--source-oci-artifact-image string source oci artifact image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest

--source-oci-artifact-prune pruneOption source oci artifact image prune option, either Never, or AfterPull (default Never)

--source-oci-artifact-image string source OCI artifact image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest

--source-oci-artifact-prune pruneOption source OCI artifact image prune option, either Never, or AfterPull (default Never)

I believe this doc is auto-generated, so it needs to be made in the respective go code.

HeavyWombat · 2025-03-24T13:50:32Z

pkg/shp/cmd/build/create.go

 	"github.com/spf13/cobra"

+	v1 "k8s.io/api/core/v1"


For consistency, we should use "full name".

Suggested change

v1 "k8s.io/api/core/v1"

corev1 "k8s.io/api/core/v1"

HeavyWombat · 2025-03-24T13:54:45Z

pkg/shp/flags/build.go

+			Git: &buildv1beta1.Git{
+				Revision:    ptr.To(""),
+				CloneSecret: ptr.To(""),
+			},
+			OCIArtifact: &buildv1beta1.OCIArtifact{
+				Prune:      &pruneOption,
+				PullSecret: ptr.To(""),


Seems a bit a weird to me to initialize everything with pointers to empty strings just to be later updated by flag values, if I understand it correctly. Is there any way we can simplify this? What do you think?

I think we can take this up as a follow-up item to address. Since this PR is a pure refactor, I'd prefer to keep the existing behavior as close as possible to status quo.

adambkaplan

/approve

Giving the 👍 for this change to go into v0.16. I called out a few items I noticed in my review.

adambkaplan · 2025-03-26T14:39:09Z

docs/shp_build_create.md

+      --source-oci-artifact-image string         source oci artifact image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest
+      --source-oci-artifact-prune pruneOption    source oci artifact image prune option, either Never, or AfterPull (default Never)


I believe this doc is auto-generated, so it needs to be made in the respective go code.

adambkaplan · 2025-03-26T14:43:32Z

pkg/shp/cmd/build/create.go

+	if dockerfile != nil && *dockerfile != "" {
+		buildSpecFlags.Env = append(buildSpecFlags.Env, v1.EnvVar{Name: "dockerfile", Value: *dockerfile})
+	}


If the intent is to mimic the conversion webhook logic, the Dockerfile should be made a parameter, not an environment variable: https://github.com/shipwright-io/build/blob/main/pkg/apis/build/v1beta1/build_conversion.go#L169-L177

adambkaplan · 2025-03-26T14:44:05Z

pkg/shp/cmd/build/create.go

+	if builderImage != nil && *builderImage != "" {
+		buildSpecFlags.Env = append(buildSpecFlags.Env, v1.EnvVar{Name: "builder-image", Value: *builderImage})
+	}


Ditto - convert to a parameter: https://github.com/shipwright-io/build/blob/main/pkg/apis/build/v1beta1/build_conversion.go#L180-L188

adambkaplan · 2025-03-26T14:49:15Z

pkg/shp/cmd/buildrun/create.go

 		return err
 	}
-	fmt.Fprintf(ioStreams.Out, "BuildRun created %q for Build %q\n", c.name, br.Spec.BuildRef.Name)
+	fmt.Fprintf(ioStreams.Out, "BuildRun created %q for Build %q\n", c.name, *br.Spec.Build.Name)


Risk of nil pointer dereference panic?

adambkaplan · 2025-03-26T14:53:19Z

pkg/shp/flags/build.go

+			Git: &buildv1beta1.Git{
+				Revision:    ptr.To(""),
+				CloneSecret: ptr.To(""),
+			},
+			OCIArtifact: &buildv1beta1.OCIArtifact{
+				Prune:      &pruneOption,
+				PullSecret: ptr.To(""),


I think we can take this up as a follow-up item to address. Since this PR is a pure refactor, I'd prefer to keep the existing behavior as close as possible to status quo.

adambkaplan · 2025-03-26T15:46:24Z

pkg/shp/flags/flags.go

+		&source.OCIArtifact.Image,
+		SourceOciArtifactImageFlag,
+		"",
+		"source bundle image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest",


Suggested change

"source bundle image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest",

"source OCI artifact reference, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest",

adambkaplan · 2025-03-26T15:47:37Z

pkg/shp/flags/flags.go

 	// SourceBundleImageFlag command-line flag
-	SourceBundleImageFlag = "source-bundle-image"
+	SourceOciArtifactImageFlag = "source-oci-artifact-image"


nit - OCI is an acronym and should be in caps

Suggested change

SourceOciArtifactImageFlag = "source-oci-artifact-image"

SourceOCIArtifactImageFlag = "source-oci-artifact-image"

adambkaplan · 2025-03-26T15:48:25Z

pkg/shp/flags/flags.go

+	SourceOciArtifactPruneFlag = "source-oci-artifact-prune"
+	// SourceOciArtifactPullSecretFlag command-line flag
+	SourceOciArtifactPullSecretFlag = "source-oci-artifact-pull-secret" // #nosec G101


nit - OCI should be capitalized

Suggested change

SourceOciArtifactPruneFlag = "source-oci-artifact-prune"

// SourceOciArtifactPullSecretFlag command-line flag

SourceOciArtifactPullSecretFlag = "source-oci-artifact-pull-secret" // #nosec G101

SourceOCIArtifactPruneFlag = "source-oci-artifact-prune"

// SourceOCIArtifactPullSecretFlag command-line flag

SourceOCIArtifactPullSecretFlag = "source-oci-artifact-pull-secret" // #nosec G101

adambkaplan · 2025-03-26T15:50:04Z

pkg/shp/flags/flags.go

+		"",
+		"path to dockerfile relative to repository",
+	)
+	flags.MarkDeprecated("builder-image", "builder-image parameter is deprecated")


Suggested change

flags.MarkDeprecated("builder-image", "builder-image parameter is deprecated")

flags.MarkDeprecated("builder-image", "builder-image flag is deprecated, and will be removed in a future release. Use an appropriate parameter for the build strategy instead.")

adambkaplan · 2025-03-26T15:51:10Z

pkg/shp/flags/flags.go

-	flags.BoolVar(
-		sa.Generate,
-		ServiceAccountGenerateFlag,
-		false,
-		"generate a Kubernetes service-account for the build",
-	)


This flag should be retained and marked deprecated. OK if this flag does nothing.

openshift-ci · 2025-03-26T16:33:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adambkaplan

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [adambkaplan]

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

Signed-off-by: Karan Kumar <[email protected]>

openshift-ci bot added the release-note label Mar 24, 2025

pull-request-size bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Mar 24, 2025

shipwright-ci-bot added this to Shipwright Overview Mar 24, 2025

openshift-ci bot requested review from HeavyWombat and qu1queee March 24, 2025 06:28

HeavyWombat requested changes Mar 24, 2025

View reviewed changes

HeavyWombat requested a review from SaschaSchwarze0 March 24, 2025 13:57

karanibm6 mentioned this pull request Mar 24, 2025

[FEATURE] Use v1beta1 APIs Only #294

Open

1 task

adambkaplan reviewed Mar 26, 2025

View reviewed changes

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 26, 2025

karanibm6 force-pushed the update-cli-params branch 2 times, most recently from 8320cbf to 74ec843 Compare April 7, 2025 03:43

pull-request-size bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Apr 7, 2025

karanibm6 force-pushed the update-cli-params branch 4 times, most recently from 1db8031 to 964803e Compare April 7, 2025 06:05

karanibm6 added 3 commits April 7, 2025 18:27

add cli changes to move to v1beta1 from v1alpha1

5684df7

Signed-off-by: Karan Kumar <[email protected]>

add updated docs for various commands

97d6569

Signed-off-by: Karan Kumar <[email protected]>

refactor code and fix review comments

cfea747

Signed-off-by: Karan Kumar <[email protected]>

karanibm6 force-pushed the update-cli-params branch from 8cb2147 to cfea747 Compare April 7, 2025 12:59

karanibm6 requested review from HeavyWombat and adambkaplan April 7, 2025 18:05

inline e2e tests with updated parameters

359459c

Signed-off-by: Karan Kumar <[email protected]>

karanibm6 force-pushed the update-cli-params branch from e051935 to 359459c Compare April 7, 2025 18:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add cli changes to move to v1beta1 #304

add cli changes to move to v1beta1 #304

karanibm6 commented Mar 24, 2025 •

edited

Loading

HeavyWombat left a comment

HeavyWombat Mar 24, 2025

adambkaplan Mar 26, 2025

karanibm6 Apr 7, 2025

HeavyWombat Mar 24, 2025

HeavyWombat Mar 24, 2025

adambkaplan Mar 26, 2025

adambkaplan left a comment

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

karanibm6 Apr 7, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

adambkaplan Mar 26, 2025

openshift-ci bot commented Mar 26, 2025

		--source-oci-artifact-image string source oci artifact image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest
		--source-oci-artifact-prune pruneOption source oci artifact image prune option, either Never, or AfterPull (default Never)

	"source bundle image location, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest",
	"source OCI artifact reference, e.g. ghcr.io/shipwright-io/sample-go/source-bundle:latest",

	SourceOciArtifactImageFlag = "source-oci-artifact-image"
	SourceOCIArtifactImageFlag = "source-oci-artifact-image"

	flags.MarkDeprecated("builder-image", "builder-image parameter is deprecated")
	flags.MarkDeprecated("builder-image", "builder-image flag is deprecated, and will be removed in a future release. Use an appropriate parameter for the build strategy instead.")

add cli changes to move to v1beta1 #304

Are you sure you want to change the base?

add cli changes to move to v1beta1 #304

Conversation

karanibm6 commented Mar 24, 2025 • edited Loading

Changes

Submitter Checklist

Release Notes

HeavyWombat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adambkaplan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openshift-ci bot commented Mar 26, 2025

karanibm6 commented Mar 24, 2025 •

edited

Loading