Consolidate Result and ResultV2 types for GA

Remove old Result type and rename ResultV2 to Result, following
Stefan's review feedback to eliminate complex nested structures.
This creates a single, flat Result type containing only FileChanges
for improved API simplicity.

Breaking changes:
- .Changed.ImageResult.Files/.Images/.Objects no longer available
- Users must migrate to .Changed.FileChanges, .Changed.Objects,
  and .Changed.Changes

Enhanced error handling provides specific guidance for removed
template fields, setting Stalled condition with clear migration
instructions. Updated documentation includes removal notes and
migration examples.

Signed-off-by: cappyzawa <[email protected]>

Author: cappyzawa

api/v1beta2/git.go

@@ -65,6 +65,7 @@ type CommitSpec struct {
 	SigningKey *SigningKey `json:"signingKey,omitempty"`
 	// MessageTemplate provides a template for the commit message,
 	// into which will be interpolated the details of the change made.
+	// Note: The `Updated` template field has been removed. Use `Changed` instead.
 	// +optional
 	MessageTemplate string `json:"messageTemplate,omitempty"`
 

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

@@ -440,6 +440,7 @@ spec:
                         description: |-
                           MessageTemplate provides a template for the commit message,
                           into which will be interpolated the details of the change made.
+                          Note: The `Updated` template field has been removed. Use `Changed` instead.
                         type: string
                       messageTemplateValues:
                         additionalProperties:

docs/api/v1beta2/image-automation.md

@@ -67,7 +67,8 @@ string
 <td>
 <em>(Optional)</em>
 <p>MessageTemplate provides a template for the commit message,
-into which will be interpolated the details of the change made.</p>
+into which will be interpolated the details of the change made.
+Note: The <code>Updated</code> template field has been removed. Use <code>Changed</code> instead.</p>
 </td>
 </tr>
 <tr>

docs/spec/v1beta2/imageupdateautomations.md

@@ -380,6 +380,7 @@ including partial updates to just the image name or the tag, not just full image
 with name and tag update. Templates using `Updated` will result in an error and
 the ImageUpdateAutomation will be marked as Stalled.
 
+
 The message template also has access to the data related to the changes made by
 the automation. The template is a [Go text template][go-text-template]. The data
 available to the template have the following structure (not reproduced
@@ -392,14 +393,14 @@ type TemplateData struct {
 	AutomationObject struct {
 	  Name, Namespace string
 	}
-	Changed update.ResultV2
+	Changed update.Result
 	Values map[string]string
 }
 
-// ResultV2 contains the file changes made during the update. It contains
+// Result contains the file changes made during the update. It contains
 // details about the exact changes made to the files and the objects in them. It
 // has a nested structure file->objects->changes.
-type ResultV2 struct {
+type Result struct {
 	FileChanges map[string]ObjectChanges
 }
 
@@ -426,10 +427,10 @@ over the changed objects and changes:
 
 ```go
 // Changes returns all the changes that were made in at least one update.
-func (r ResultV2) Changes() []Change
+func (r Result) Changes() []Change
 
 // Objects returns ObjectChanges, regardless of which file they appear in.
-func (r ResultV2) Objects() ObjectChanges
+func (r Result) Objects() ObjectChanges
 ```
 
 Example of using the methods in a template:

internal/controller/imageupdateautomation_controller_test.go

@@ -71,12 +71,12 @@ const (
 Automation: {{ .AutomationObject }}
 
 Files:
-{{ range $filename, $_ := .Changed.ImageResult.Files -}}
+{{ range $filename, $_ := .Changed.FileChanges -}}
 - {{ $filename }}
 {{ end -}}
 
 Objects:
-{{ range $resource, $_ := .Changed.ImageResult.Objects -}}
+{{ range $resource, $_ := .Changed.Objects -}}
 {{ if eq $resource.Kind "Deployment" -}}
 - {{ $resource.Kind | lower }} {{ $resource.Name | lower }}
 {{ else -}}
@@ -85,8 +85,10 @@ Objects:
 {{ end -}}
 
 Images:
-{{ range .Changed.ImageResult.Images -}}
-- {{.}} ({{.Policy.Name}})
+{{ range .Changed.Changes -}}
+{{ if .Setter -}}
+- {{.NewValue}} ({{.Setter}})
+{{ end -}}
 {{ end -}}
 `
 	testCommitMessageFmt = `Commit summary
@@ -98,7 +100,7 @@ Files:
 Objects:
 - deployment test
 Images:
-- helloworld:v1.0.0 (%s)
+- helloworld:v1.0.0 (%s:%s)
 `
 )
 
@@ -727,7 +729,7 @@ func TestImageUpdateAutomationReconciler_commitMessage(t *testing.T) {
 			name:     "template with update Result",
 			template: testCommitTemplate,
 			wantCommitMsg: func(policyName, policyNS string) string {
-				return fmt.Sprintf(testCommitMessageFmt, policyNS, policyName)
+				return fmt.Sprintf(testCommitMessageFmt, policyNS, policyNS, policyName)
 			},
 		},
 		{
@@ -841,11 +843,8 @@ Automation: %s/update-test
 	}
 }
 
-// TestImageUpdateAutomationReconciler_removedTemplateField tests removed .Updated template field usage.
+// TestImageUpdateAutomationReconciler_removedTemplateField tests removed template field usage (.Updated and .Changed.ImageResult).
 func TestImageUpdateAutomationReconciler_removedTemplateField(t *testing.T) {
-	g := NewWithT(t)
-	ctx := context.TODO()
-
 	policySpec := imagev1_reflect.ImagePolicySpec{
 		ImageRepositoryRef: meta.NamespacedObjectReference{
 			Name: "not-expected-to-exist",
@@ -859,7 +858,14 @@ func TestImageUpdateAutomationReconciler_removedTemplateField(t *testing.T) {
 	fixture := "testdata/appconfig"
 	latest := "helloworld:v1.0.0"
 
-	removedTemplate := `Commit summary
+	testCases := []struct {
+		name           string
+		template       string
+		expectedErrMsg string
+	}{
+		{
+			name: ".Updated field",
+			template: `Commit summary
 
 Automation: {{ .AutomationObject }}
 
@@ -881,55 +887,88 @@ Images:
 {{ range .Updated.Images -}}
 - {{.}} ({{.Policy.Name}})
 {{ end -}}
-`
+`,
+			expectedErrMsg: "template uses removed '.Updated' field",
+		},
+		{
+			name: ".Changed.ImageResult field",
+			template: `Commit summary
 
-	namespace, err := testEnv.CreateNamespace(ctx, "image-auto-test")
-	g.Expect(err).ToNot(HaveOccurred())
-	defer func() { g.Expect(testEnv.Delete(ctx, namespace)).To(Succeed()) }()
+Automation: {{ .AutomationObject }}
 
-	testWithRepoAndImagePolicy(
-		ctx, g, testEnv, namespace.Name, fixture, policySpec, latest,
-		func(g *WithT, s repoAndPolicyArgs, repoURL string, localRepo *extgogit.Repository) {
-			policyKey := types.NamespacedName{
-				Name:      s.imagePolicyName,
-				Namespace: s.namespace,
-			}
-			_ = testutil.CommitInRepo(ctx, g, repoURL, s.branch, originRemote, "Install setter marker", func(tmp string) {
-				g.Expect(testutil.ReplaceMarker(filepath.Join(tmp, "deploy.yaml"), policyKey)).To(Succeed())
-			})
+Files:
+{{ range $filename, $_ := .Changed.ImageResult.Files -}}
+- {{ $filename }}
+{{ end -}}
 
-			preChangeCommitId := testutil.CommitIdFromBranch(localRepo, s.branch)
-			waitForNewHead(g, localRepo, s.branch, preChangeCommitId)
-			preChangeCommitId = testutil.CommitIdFromBranch(localRepo, s.branch)
+Objects:
+{{ range $resource, $_ := .Changed.ImageResult.Objects -}}
+- {{ $resource.Kind }} {{ $resource.Name }}
+{{ end -}}
 
-			updateStrategy := &imagev1.UpdateStrategy{
-				Strategy: imagev1.UpdateStrategySetters,
-			}
-			err := createImageUpdateAutomation(ctx, testEnv, "update-test", s.namespace, s.gitRepoName, s.gitRepoNamespace, s.branch, s.branch, "", removedTemplate, "", updateStrategy)
+Images:
+{{ range .Changed.ImageResult.Images -}}
+- {{.}} ({{.Policy.Name}})
+{{ end -}}
+`,
+			expectedErrMsg: "template uses removed '.Changed.ImageResult' field",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			g := NewWithT(t)
+			ctx := context.TODO()
+
+			namespace, err := testEnv.CreateNamespace(ctx, "image-auto-test")
 			g.Expect(err).ToNot(HaveOccurred())
-			defer func() {
-				g.Expect(deleteImageUpdateAutomation(ctx, testEnv, "update-test", s.namespace)).To(Succeed())
-			}()
+			defer func() { g.Expect(testEnv.Delete(ctx, namespace)).To(Succeed()) }()
 
-			imageUpdateKey := types.NamespacedName{
-				Namespace: s.namespace,
-				Name:      "update-test",
-			}
+			testWithRepoAndImagePolicy(
+				ctx, g, testEnv, namespace.Name, fixture, policySpec, latest,
+				func(g *WithT, s repoAndPolicyArgs, repoURL string, localRepo *extgogit.Repository) {
+					policyKey := types.NamespacedName{
+						Name:      s.imagePolicyName,
+						Namespace: s.namespace,
+					}
+					_ = testutil.CommitInRepo(ctx, g, repoURL, s.branch, originRemote, "Install setter marker", func(tmp string) {
+						g.Expect(testutil.ReplaceMarker(filepath.Join(tmp, "deploy.yaml"), policyKey)).To(Succeed())
+					})
 
-			g.Eventually(func() bool {
-				var imageUpdate imagev1.ImageUpdateAutomation
-				_ = testEnv.Get(context.TODO(), imageUpdateKey, &imageUpdate)
-				stalledCondition := apimeta.FindStatusCondition(imageUpdate.Status.Conditions, meta.StalledCondition)
-				return stalledCondition != nil &&
-					stalledCondition.Status == metav1.ConditionTrue &&
-					stalledCondition.Reason == imagev1.RemovedTemplateFieldReason &&
-					strings.Contains(stalledCondition.Message, "template uses removed '.Updated' field")
-			}, timeout).Should(BeTrue())
+					preChangeCommitId := testutil.CommitIdFromBranch(localRepo, s.branch)
+					waitForNewHead(g, localRepo, s.branch, preChangeCommitId)
+					preChangeCommitId = testutil.CommitIdFromBranch(localRepo, s.branch)
 
-			head, _ := localRepo.Head()
-			g.Expect(head.Hash().String()).To(Equal(preChangeCommitId))
-		},
-	)
+					updateStrategy := &imagev1.UpdateStrategy{
+						Strategy: imagev1.UpdateStrategySetters,
+					}
+					err := createImageUpdateAutomation(ctx, testEnv, "update-test", s.namespace, s.gitRepoName, s.gitRepoNamespace, s.branch, s.branch, "", tc.template, "", updateStrategy)
+					g.Expect(err).ToNot(HaveOccurred())
+					defer func() {
+						g.Expect(deleteImageUpdateAutomation(ctx, testEnv, "update-test", s.namespace)).To(Succeed())
+					}()
+
+					imageUpdateKey := types.NamespacedName{
+						Namespace: s.namespace,
+						Name:      "update-test",
+					}
+
+					g.Eventually(func() bool {
+						var imageUpdate imagev1.ImageUpdateAutomation
+						_ = testEnv.Get(context.TODO(), imageUpdateKey, &imageUpdate)
+						stalledCondition := apimeta.FindStatusCondition(imageUpdate.Status.Conditions, meta.StalledCondition)
+						return stalledCondition != nil &&
+							stalledCondition.Status == metav1.ConditionTrue &&
+							stalledCondition.Reason == imagev1.RemovedTemplateFieldReason &&
+							strings.Contains(stalledCondition.Message, tc.expectedErrMsg)
+					}, timeout).Should(BeTrue())
+
+					head, _ := localRepo.Head()
+					g.Expect(head.Hash().String()).To(Equal(preChangeCommitId))
+				},
+			)
+		})
+	}
 }
 
 func TestImageUpdateAutomationReconciler_crossNamespaceRef(t *testing.T) {
@@ -966,7 +1005,7 @@ func TestImageUpdateAutomationReconciler_crossNamespaceRef(t *testing.T) {
 	testWithCustomRepoAndImagePolicy(
 		ctx, g, testEnv, fixture, policySpec, latest, args,
 		func(g *WithT, s repoAndPolicyArgs, repoURL string, localRepo *extgogit.Repository) {
-			commitMessage := fmt.Sprintf(testCommitMessageFmt, s.namespace, s.imagePolicyName)
+			commitMessage := fmt.Sprintf(testCommitMessageFmt, s.namespace, s.namespace, s.imagePolicyName)
 
 			// Update the setter marker in the repo.
 			policyKey := types.NamespacedName{

internal/policy/applier.go

@@ -42,8 +42,8 @@ var (
 
 // ApplyPolicies applies the given set of policies on the source present in the
 // workDir based on the provided ImageUpdateAutomation configuration.
-func ApplyPolicies(ctx context.Context, workDir string, obj *imagev1.ImageUpdateAutomation, policies []imagev1_reflect.ImagePolicy) (update.ResultV2, error) {
-	var result update.ResultV2
+func ApplyPolicies(ctx context.Context, workDir string, obj *imagev1.ImageUpdateAutomation, policies []imagev1_reflect.ImagePolicy) (update.Result, error) {
+	var result update.Result
 	if obj.Spec.Update == nil {
 		return result, ErrNoUpdateStrategy
 	}
@@ -62,5 +62,5 @@ func ApplyPolicies(ctx context.Context, workDir string, obj *imagev1.ImageUpdate
 	}
 
 	tracelog := log.FromContext(ctx).V(logger.TraceLevel)
-	return update.UpdateV2WithSetters(tracelog, manifestPath, manifestPath, policies)
+	return update.UpdateWithSetters(tracelog, manifestPath, manifestPath, policies)
 }

internal/policy/applier_test.go

@@ -31,7 +31,6 @@ import (
 	imagev1 "github.com/fluxcd/image-automation-controller/api/v1beta2"
 	"github.com/fluxcd/image-automation-controller/internal/testutil"
 	"github.com/fluxcd/image-automation-controller/pkg/test"
-	"github.com/fluxcd/image-automation-controller/pkg/update"
 )
 
 func testdataPath(path string) string {
@@ -48,7 +47,6 @@ func Test_applyPolicies(t *testing.T) {
 		inputPath          string
 		expectedPath       string
 		wantErr            bool
-		wantResult         update.Result
 	}{
 		{
 			name: "valid update strategy and one policy",

internal/source/source.go

@@ -48,16 +48,36 @@ import (
 // ErrInvalidSourceConfiguration is an error for invalid source configuration.
 var ErrInvalidSourceConfiguration = errors.New("invalid source configuration")
 
-// ErrRemovedTemplateField is an error for removed template field usage.
-var ErrRemovedTemplateField = errors.New("template uses removed '.Updated' field. Please use '.Changed' instead. See: https://fluxcd.io/flux/components/image/imageupdateautomations/#message-template")
+// RemovedTemplateFieldError represents an error when a removed template field is used.
+type RemovedTemplateFieldError struct {
+	Field string
+}
+
+func (e *RemovedTemplateFieldError) Error() string {
+	switch e.Field {
+	case ".Updated":
+		return "template uses removed '.Updated' field. Please use '.Changed' instead. See: https://fluxcd.io/flux/components/image/imageupdateautomations/#message-template"
+	case ".Changed.ImageResult":
+		return "template uses removed '.Changed.ImageResult' field. Please use '.Changed.FileChanges' or '.Changed.Objects' instead. See: https://fluxcd.io/flux/components/image/imageupdateautomations/#message-template"
+	default:
+		return fmt.Sprintf("template uses removed '%s' field. See: https://fluxcd.io/flux/components/image/imageupdateautomations/#message-template", e.Field)
+	}
+}
+
+func (e *RemovedTemplateFieldError) Is(target error) bool {
+	return errors.Is(target, ErrRemovedTemplateField)
+}
+
+// ErrRemovedTemplateField is a sentinel error for removed template field usage.
+var ErrRemovedTemplateField = &RemovedTemplateFieldError{}
 
 const defaultMessageTemplate = `Update from image update automation`
 
 // TemplateData is the type of the value given to the commit message
 // template.
 type TemplateData struct {
 	AutomationObject types.NamespacedName
-	Changed          update.ResultV2
+	Changed          update.Result
 	Values           map[string]string
 }
 
@@ -270,7 +290,7 @@ func WithPushConfigOptions(opts map[string]string) PushConfig {
 
 // CommitAndPush performs a commit in the source and pushes it to the remote
 // repository.
-func (sm SourceManager) CommitAndPush(ctx context.Context, obj *imagev1.ImageUpdateAutomation, policyResult update.ResultV2, pushOptions ...PushConfig) (*PushResult, error) {
+func (sm SourceManager) CommitAndPush(ctx context.Context, obj *imagev1.ImageUpdateAutomation, policyResult update.Result, pushOptions ...PushConfig) (*PushResult, error) {
 	tracelog := log.FromContext(ctx).V(logger.TraceLevel)
 
 	// Make sure there were file changes that need to be committed.
@@ -357,14 +377,32 @@ func templateMsg(messageTemplate string, templateValues *TemplateData) (string,
 
 	b := &strings.Builder{}
 	if err := t.Execute(b, *templateValues); err != nil {
-		if strings.Contains(err.Error(), "can't evaluate field Updated in type source.TemplateData") {
-			return "", ErrRemovedTemplateField
+		if removedFieldErr := checkRemovedTemplateField(err); removedFieldErr != nil {
+			return "", removedFieldErr
 		}
 		return "", fmt.Errorf("failed to run template from spec: %w", err)
 	}
 	return b.String(), nil
 }
 
+// checkRemovedTemplateField checks if the template error is due to removed fields
+func checkRemovedTemplateField(err error) error {
+	removedFieldChecks := []struct {
+		fieldName    string
+		errorPattern string
+	}{
+		{".Updated", "can't evaluate field Updated in type source.TemplateData"},
+		{".Changed.ImageResult", "can't evaluate field ImageResult in type update.Result"},
+	}
+
+	for _, check := range removedFieldChecks {
+		if strings.Contains(err.Error(), check.errorPattern) {
+			return &RemovedTemplateFieldError{Field: check.fieldName}
+		}
+	}
+	return nil
+}
+
 // PushResultOption allows configuring the options of PushResult.
 type PushResultOption func(*PushResult)