Representing Shipwright resources as flags.

Extending `flags` package to support Build and BuildRun objects, reusing
shared flags among resources. Adding more tests and documentation.

Co-authored-by: Adam Kaplan <adam.kaplan@redhat.com>

pkg/shp/flags/build.go

@@ -7,8 +7,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// BuildSpecFlags creates a BuildSpec instance based on command-line flags.
-func BuildSpecFlags(flags *pflag.FlagSet) *buildv1alpha1.BuildSpec {
+// BuildSpecFromFlags creates a BuildSpec instance based on command-line flags.
+func BuildSpecFromFlags(flags *pflag.FlagSet) *buildv1alpha1.BuildSpec {
 	clusterBuildStrategyKind := buildv1alpha1.ClusterBuildStrategyKind
 	spec := &buildv1alpha1.BuildSpec{
 		Source: buildv1alpha1.Source{
@@ -45,7 +45,7 @@ func BuildSpecFlags(flags *pflag.FlagSet) *buildv1alpha1.BuildSpec {
 	return spec
 }
 
-// SanitizeBuildSpec checks for empty inner data structure and replaces them with nil.
+// SanitizeBuildSpec checks for empty inner data structures and replaces them with nil.
 func SanitizeBuildSpec(b *buildv1alpha1.BuildSpec) {
 	if b == nil {
 		return

pkg/shp/flags/buildrun.go

@@ -8,8 +8,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// BuildRunSpecFlags BuildRun's spec represtantation as command-line flags.
-func BuildRunSpecFlags(flags *pflag.FlagSet) *buildv1alpha1.BuildRunSpec {
+// BuildRunSpecFromFlags creates a BuildRun spec from command-line flags.
+func BuildRunSpecFromFlags(flags *pflag.FlagSet) *buildv1alpha1.BuildRunSpec {
 	spec := &buildv1alpha1.BuildRunSpec{
 		BuildRef:       &buildv1alpha1.BuildRef{},
 		ServiceAccount: &buildv1alpha1.ServiceAccount{},
@@ -27,7 +27,7 @@ func BuildRunSpecFlags(flags *pflag.FlagSet) *buildv1alpha1.BuildRunSpec {
 	return spec
 }
 
-// SanitizeBuildRunSpec when inner elements are empty, making sure they are replace by a nil pointer.
+// SanitizeBuildRunSpec checks for empty inner data structures and replaces them with nil.
 func SanitizeBuildRunSpec(br *buildv1alpha1.BuildRunSpec) {
 	if br == nil {
 		return