add support for specifying push options

Add `.spec.git.push.options` to allow specifying the push options to be sent to the upstream Git server during a push operation. For more info, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt This is useful for platforms like GitLab when used with image-automation-controller by enabling the creation of MRs automatically upon a push operation (ref: https://docs.gitlab.com/ee/user/project/push_options.html#push-options-for-merge-requests) Signed-off-by: Sanskar Jaiswal <[email protected]>
fluxcd · Aug 23, 2023 · 1dd0e63 · 1dd0e63
1 parent 1e0fad1
commit 1dd0e63
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 6 deletions.
diff --git a/api/v1beta1/git.go b/api/v1beta1/git.go
@@ -95,4 +95,10 @@ type PushSpec struct {
 	// https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
 	// +optional
 	Refspec string `json:"refspec,omitempty"`
+
+	// Options specifies the push options that are sent to the Git
+	// server when performing a push operation. For details, see:
+	// https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt
+	// +optional
+	Options map[string]string `json:"options,omitempty"`
 }
diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml b/config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml
@@ -135,6 +135,13 @@ spec:
                           to the branch named. The branch is created using `.spec.checkout.branch`
                           as the starting point, if it doesn't already exist.
                         type: string
+                      options:
+                        additionalProperties:
+                          type: string
+                        description: 'Options specifies the push options that are
+                          sent to the Git server when performing a push operation.
+                          For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt'
+                        type: object
                       refspec:
                         description: 'Refspec specifies the Git Refspec to use for
                           a push operation. If both Branch and Refspec are provided,

diff --git a/docs/api/v1beta1/image-automation.md b/docs/api/v1beta1/image-automation.md
@@ -660,6 +660,20 @@ For more details about Git Refspecs, see:
 <a href="https://git-scm.com/book/en/v2/Git-Internals-The-Refspec">https://git-scm.com/book/en/v2/Git-Internals-The-Refspec</a></p>
 </td>
 </tr>
+<tr>
+<td>
+<code>options</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Options specifies the push options that are sent to the Git
+server when performing a push operation. For details, see:
+<a href="https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt">https://git-scm.com/docs/git-push#Documentation/git-push.txt&mdash;push-optionltoptiongt</a></p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>

diff --git a/docs/spec/v1beta1/imageupdateautomations.md b/docs/spec/v1beta1/imageupdateautomations.md
@@ -419,6 +419,11 @@ type PushSpec struct {
 	// https://git-scm.com/book/en/v2/Git-Internals-The-Refspec
 	// +optional
 	Refspec string `json:"refspec,omitempty"`
+
+	// Options specifies the push options that are sent to the Git
+	// server when performing a push operation. For details, see:
+	// https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt
+	Options map[string]string `json:"options,omitempty"`
 }
 ```
 
@@ -477,8 +482,23 @@ spec:
       refspec: refs/heads/main:refs/heads/auto
 ```
 
-#### Gerrit
+To specify the [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt)
+to be sent to the upstream Git server, use `.push.options`. These options can be
+used to perform operations as a result of the push. For example, using the below
+push options will open a GitLab Merge Request to the `release` branch
+automatically with the commit the controller pushed to the `dev` branch:
 
+```yaml
+spec:
+  git:
+    push:
+      branch: dev
+      options:
+        merge_request.create: ""
+        merge_request.target: release
+```
+
+#### Gerrit
 
 [Gerrit](https://www.gerritcodereview.com/) operates differently from a
 standard Git server. Rather than sending individual commits to a branch,

diff --git a/internal/controller/imageupdateautomation_controller.go b/internal/controller/imageupdateautomation_controller.go
@@ -416,11 +416,14 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 			pushToBranch = true
 		}
 
+		var pushConfig repository.PushConfig
+		if gitSpec.Push != nil {
+			pushConfig.Options = gitSpec.Push.Options
+		}
 		if pushToBranch {
 			// If the force push feature flag is true and we are pushing to a
 			// different branch than the one we checked out to, then force push
 			// these changes.
-			var pushConfig repository.PushConfig
 			forcePush := r.features[features.GitForcePushBranch]
 			if forcePush && switchBranch {
 				pushConfig.Force = true
@@ -434,9 +437,7 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 		}
 
 		if pushWithRefspec {
-			pushConfig := repository.PushConfig{
-				Refspecs: []string{gitSpec.Push.Refspec},
-			}
+			pushConfig.Refspecs = []string{gitSpec.Push.Refspec}
 			if err := gitClient.Push(pushCtx, pushConfig); err != nil {
 				return failWithError(err)
 			}