API changes: fix Go-type convention, fix required fields, remove undocumented old parameters

[SaschaSchwarze0]

Changes

• Make Build.Spec.Source optional
• Rename Build.Spec.Source.GitSource to Git (go-type only)
• Rename Build.Spec.Source.LocalSource to Local (go-type only)
• Rename BuildRun.Spec.Build.Build to Spec (go-type only)
• Rename BuildRun.Spec.Source.LocalSource to Local (go-type only)
• Remove the undocumented CONTEXT_DIR parameter
• Remove the undocumented build.output.image and build.source.contextDir replacement variables
• Declare Build.Spec.Source.Type as required
• Declare BuildRun.Spec.Source.Type as required
• Add missing documentation to API fields

Fixes #1484
Fixes #1490

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

Release Notes

You can now define a Build without any source. This is for example useful when you want to run this build only with local source. Also, some corrections have been made to the Go types.

[HeavyWombat]

@SaschaSchwarze0 Following the discussion we had on naming things, shouldn't the embedded build specification here also be renamed to something like "BuildSpec"? We actually have one place where we use it like buildRun.Spec.Build.Build, which looks counterintuitive.

[SaschaSchwarze0]

@SaschaSchwarze0 Following the discussion we had on naming things, shouldn't the embedded build specification here also be renamed to something like "BuildSpec"? We actually have one place where we use it like buildRun.Spec.Build.Build, which looks counterintuitive.

Good catch. It should actually be Spec as that's the json field name.

[qu1queee]

@adambkaplan I saw some of the docs in OpenShift, I think you should take a look on this PR as well. for example making the Build.Spec.Source.Type as required, might be of your interest.

[SaschaSchwarze0]

@adambkaplan I saw some of the docs in OpenShift, I think you should take a look on this PR as well. for example making the Build.Spec.Source.Type as required, might be of your interest.

+1 I pinged it privately to Adam already that the OpenShift docs miss the type field. :-) But, code-wise, the source.type is already required. Basically this code,

build/pkg/reconciler/buildrun/resources/sources.go

Lines 66 to 78 in 0885a82

	// create the step for spec.source, either Git or Bundle
	switch build.Spec.Source.Type {
	case buildv1beta1.OCIArtifactType:
	if build.Spec.Source.OCIArtifact != nil {
	appendSourceTimestampResult(taskSpec)
	sources.AppendBundleStep(cfg, taskSpec, build.Spec.Source.OCIArtifact, defaultSourceName)
	}
	case buildv1beta1.GitType:
	if build.Spec.Source.GitSource != nil {
	appendSourceTimestampResult(taskSpec)
	sources.AppendGitStep(cfg, taskSpec, *build.Spec.Source.GitSource, defaultSourceName)
	}
	}

, would not work if you don't have the type set. This PR here only declares it as required.

[HeavyWombat]

/lgtm

[HeavyWombat]

@SaschaSchwarze0 Maybe the PR title should be edited to be a bit more telling.

[SaschaSchwarze0]

Rebased to resolve conflicts.

[HeavyWombat]

/lgtm

[HeavyWombat]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: HeavyWombat

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 [HeavyWombat]

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