🌱 (chore): avoid shadowing of 'config', 'err', and patch error in helm and deploy-image scaffolds (#4660)

fix: avoid shadowing of 'config', 'err', and patch error in helm and deploy-image scaffolds

Renamed variables and parameters in pkg/plugins/optional/helm/v1alpha and
pkg/plugins/golang/deploy-image/v1alpha1 to avoid shadowing: 'config' → 'cfg',
reused 'err' instead of shadowing it with ':=' assignments, and separated
'errPatch' from the main error flow. These changes improve error handling clarity
and prevent bugs related to accidental shadowing.

Author: kersten

pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/api.go

@@ -54,11 +54,11 @@ type apiScaffolder struct {
 }
 
 // NewDeployImageScaffolder returns a new Scaffolder for declarative
-func NewDeployImageScaffolder(config config.Config, res resource.Resource, image,
+func NewDeployImageScaffolder(cfg config.Config, res resource.Resource, image,
 	command, port, runAsUser string,
 ) plugins.Scaffolder {
 	return &apiScaffolder{
-		config:    config,
+		config:    cfg,
 		resource:  res,
 		image:     image,
 		command:   command,
@@ -152,8 +152,7 @@ func (s *apiScaffolder) addEnvVarIntoManager() error {
 	managerPath := filepath.Join("config", "manager", "manager.yaml")
 	err := util.ReplaceInFile(managerPath, `env:`, `env:`)
 	if err != nil {
-		if err := util.InsertCode(managerPath, `name: manager`, `
-        env:`); err != nil {
+		if err = util.InsertCode(managerPath, `name: manager`, "\n        env:"); err != nil {
 			return fmt.Errorf("error scaffolding env key in config/manager/manager.yaml")
 		}
 	}

pkg/plugins/optional/helm/v1alpha/scaffolds/init.go

@@ -39,7 +39,7 @@ import (
 	templatesmetrics "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/chart-templates/metrics"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/chart-templates/prometheus"
 	templateswebhooks "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/chart-templates/webhook"
-	github "sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/github"
+	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/optional/helm/v1alpha/scaffolds/internal/templates/github"
 )
 
 var _ plugins.Scaffolder = &initScaffolder{}
@@ -53,9 +53,9 @@ type initScaffolder struct {
 }
 
 // NewInitHelmScaffolder returns a new Scaffolder for HelmPlugin
-func NewInitHelmScaffolder(config config.Config, force bool) plugins.Scaffolder {
+func NewInitHelmScaffolder(cfg config.Config, force bool) plugins.Scaffolder {
 	return &initScaffolder{
-		config: config,
+		config: cfg,
 		force:  force,
 	}
 }
@@ -111,7 +111,7 @@ func (s *initScaffolder) Scaffold() error {
 		)
 	}
 
-	if err := scaffold.Execute(buildScaffold...); err != nil {
+	if err = scaffold.Execute(buildScaffold...); err != nil {
 		return fmt.Errorf("error scaffolding helm-chart manifests: %v", err)
 	}
 
@@ -155,7 +155,7 @@ func (s *initScaffolder) extractWebhooksFromGeneratedFiles() (mutatingWebhooks [
 	validatingWebhooks []templateswebhooks.DataWebhook, err error) {
 	manifestFile := "config/webhook/manifests.yaml"
 
-	if _, err := os.Stat(manifestFile); os.IsNotExist(err) {
+	if _, err = os.Stat(manifestFile); os.IsNotExist(err) {
 		log.Printf("webhook manifests were not found at %s", manifestFile)
 		return nil, nil, nil
 	}
@@ -343,9 +343,9 @@ func copyFileWithHelmLogic(srcFile, destFile, subDir, projectName string) error
 		hasWebhookPatch := false
 
 		// Retrieve patch content for the CRD's spec.conversion, if it exists
-		patchContent, patchExists, err := getCRDPatchContent(kind, group)
-		if err != nil {
-			return err
+		patchContent, patchExists, errPatch := getCRDPatchContent(kind, group)
+		if errPatch != nil {
+			return errPatch
 		}
 
 		// If patch content exists, inject it under spec.conversion with Helm conditional
@@ -378,7 +378,7 @@ func copyFileWithHelmLogic(srcFile, destFile, subDir, projectName string) error
 			"{{- if .Values.%s.enable }}\n%s{{- end -}}\n", subDir, contentStr)
 	}
 
-	if err := os.MkdirAll(filepath.Dir(destFile), os.ModePerm); err != nil {
+	if err = os.MkdirAll(filepath.Dir(destFile), os.ModePerm); err != nil {
 		return err
 	}