Additional values for commit message template

This adds .spec.git.commit.messageTemplateValues as a map of strings
that can be used to supplement the rendering of the commit message
template.

Signed-off-by: Kevin McDermott <bigkevmcd@gmail.com>

Author: bigkevmcd

api/v1beta2/git.go

@@ -67,6 +67,10 @@ type CommitSpec struct {
 	// into which will be interpolated the details of the change made.
 	// +optional
 	MessageTemplate string `json:"messageTemplate,omitempty"`
+
+	// MessageTemplateValues provides additional values to be available to the
+	// templating rendering.
+	MessageTemplateValues map[string]string `json:"messageTemplateValues,omitempty"`
 }
 
 type CommitUser struct {

api/v1beta2/zz_generated.deepcopy.go

@@ -427,6 +427,13 @@ spec:
                           MessageTemplate provides a template for the commit message,
                           into which will be interpolated the details of the change made.
                         type: string
+                      messageTemplateValues:
+                        additionalProperties:
+                          type: string
+                        description: |-
+                          MessageTemplateValues provides additional values to be available to the
+                          templating rendering.
+                        type: object
                       signingKey:
                         description: SigningKey provides the option to sign commits
                           with a GPG key

config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml

@@ -70,6 +70,18 @@ string
 into which will be interpolated the details of the change made.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>messageTemplateValues</code><br>
+<em>
+map[string]string
+</em>
+</td>
+<td>
+<p>MessageTemplateValues provides additional values to be available to the
+templating rendering.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>

docs/api/v1beta2/image-automation.md

@@ -54,6 +54,7 @@ type TemplateData struct {
 	AutomationObject types.NamespacedName
 	Updated          update.Result
 	Changed          update.ResultV2
+	Values           map[string]string
 }
 
 // SourceManager manages source.
@@ -245,6 +246,7 @@ func (sm SourceManager) CommitAndPush(ctx context.Context, obj *imagev1.ImageUpd
 		AutomationObject: sm.automationObjKey,
 		Updated:          policyResult.ImageResult,
 		Changed:          policyResult,
+		Values:           obj.Spec.GitSpec.Commit.MessageTemplateValues,
 	}
 	commitMsg, err := templateMsg(obj.Spec.GitSpec.Commit.MessageTemplate, templateValues)
 	if err != nil {

internal/source/source.go

@@ -93,6 +93,14 @@ Automation: {{ .AutomationObject }}
 {{ end -}}
 {{ end -}}
 {{ end -}}
+`
+
+	testCommitTemplateWithValues = `Commit summary
+
+Automation: {{ .AutomationObject }}
+
+Cluster: {{ index .Values "cluster" }}
+Testing: {{ .Values.testing }}
 `
 )
 
@@ -472,6 +480,34 @@ Automation: test-ns/test-update
     - helloworld:1.0.0 -> helloworld:1.0.1
 `,
 		},
+		{
+			name: "push to cloned branch with template and values",
+			gitSpec: &imagev1.GitSpec{
+				Push: &imagev1.PushSpec{
+					Branch: "main",
+				},
+				Commit: imagev1.CommitSpec{
+					MessageTemplate: testCommitTemplateWithValues,
+					MessageTemplateValues: map[string]string{
+						"cluster": "prod",
+						"testing": "value",
+					},
+				},
+			},
+			gitRepoReference: &sourcev1.GitRepositoryRef{
+				Branch: "main",
+			},
+			latestImage: "helloworld:1.0.1",
+			wantErr:     false,
+			wantCommitMsg: `Commit summary
+
+Automation: test-ns/test-update
+
+Cluster: prod
+Testing: value
+`,
+		},
+
 		{
 			name: "push to different branch",
 			gitSpec: &imagev1.GitSpec{