Add PushSpec to image update automation type

Signed-off-by: Michael Bridgen <[email protected]>

Author: squaremo

api/v1alpha1/imageupdateautomation_types.go

@@ -39,10 +39,16 @@ type ImageUpdateAutomationSpec struct {
 	// value.
 	// +kubebuilder:default={"strategy":"Setters"}
 	Update *UpdateStrategy `json:"update,omitempty"`
-	// Commit specifies how to commit to the git repo
+	// Commit specifies how to commit to the git repository.
 	// +required
 	Commit CommitSpec `json:"commit"`
 
+	// Push specifies how and where to push commits made by the
+	// automation. If missing, commits are pushed (back) to
+	// `.spec.checkout.branch`.
+	// +optional
+	Push *PushSpec `json:"push,omitempty"`
+
 	// Suspend tells the controller to not run this automation, until
 	// it is unset (or set to false). Defaults to false.
 	// +optional
@@ -54,7 +60,9 @@ type GitCheckoutSpec struct {
 	// to a git repository to update files in.
 	// +required
 	GitRepositoryRef meta.LocalObjectReference `json:"gitRepositoryRef"`
-	// Branch gives the branch to clone from the git repository.
+	// Branch gives the branch to clone from the git repository. If
+	// `.spec.push` is not supplied, commits will also be pushed to
+	// this branch.
 	// +required
 	Branch string `json:"branch"`
 }
@@ -95,6 +103,15 @@ type CommitSpec struct {
 	MessageTemplate string `json:"messageTemplate,omitempty"`
 }
 
+// PushSpec specifies how and where to push commits.
+type PushSpec struct {
+	// Branch specifies that commits should be pushed to the branch
+	// named. The branch is created using `.spec.checkout.branch` as the
+	// starting point, if it doesn't already exist.
+	// +required
+	Branch string `json:"branch"`
+}
+
 // ImageUpdateAutomationStatus defines the observed state of ImageUpdateAutomation
 type ImageUpdateAutomationStatus struct {
 	// LastAutomationRunTime records the last time the controller ran

api/v1alpha1/zz_generated.deepcopy.go

@@ -47,6 +47,8 @@ spec:
                 properties:
                   branch:
                     description: Branch gives the branch to clone from the git repository.
+                      If `.spec.push` is not supplied, commits will also be pushed
+                      to this branch.
                     type: string
                   gitRepositoryRef:
                     description: GitRepositoryRef refers to the resource giving access
@@ -63,7 +65,7 @@ spec:
                 - gitRepositoryRef
                 type: object
               commit:
-                description: Commit specifies how to commit to the git repo
+                description: Commit specifies how to commit to the git repository.
                 properties:
                   authorEmail:
                     description: AuthorEmail gives the email to provide when making
@@ -86,6 +88,18 @@ spec:
                 description: Interval gives an lower bound for how often the automation
                   run should be attempted.
                 type: string
+              push:
+                description: Push specifies how and where to push commits made by
+                  the automation. If missing, commits are pushed (back) to `.spec.checkout.branch`.
+                properties:
+                  branch:
+                    description: Branch specifies that commits should be pushed to
+                      the branch named. The branch is created using `.spec.checkout.branch`
+                      as the starting point, if it doesn't already exist.
+                    type: string
+                required:
+                - branch
+                type: object
               suspend:
                 description: Suspend tells the controller to not run this automation,
                   until it is unset (or set to false). Defaults to false.