From 18735f08966aaff0dbe1b61d9e15a284d696f2e6 Mon Sep 17 00:00:00 2001
From: k8s-infra-cherrypick-robot
 <90416843+k8s-infra-cherrypick-robot@users.noreply.github.com>
Date: Mon, 8 Jul 2024 12:52:55 -0700
Subject: [PATCH] Mage: Stop mutating release notes. (#11582)

* Mage: Implement static check recommendations.

* Mage: Stop mutating release notes.

---------

Co-authored-by: Marco Ebert <marco_ebert@icloud.com>
---
 magefiles/steps/helm.go    | 25 +++++++++++++------------
 magefiles/steps/release.go | 14 +++++++-------
 2 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/magefiles/steps/helm.go b/magefiles/steps/helm.go
index b53283f78..245f5e1c0 100644
--- a/magefiles/steps/helm.go
+++ b/magefiles/steps/helm.go
@@ -18,9 +18,7 @@ package steps
 
 import (
 	"bytes"
-	"fmt"
 	"os"
-	"strings"
 
 	semver "github.com/blang/semver/v4"
 	"github.com/helm/helm/pkg/chartutil"
@@ -104,18 +102,21 @@ func updateVersion(version string) {
 	utils.CheckIfError(err, "HELM Saving new Chart")
 }
 
-func updateChartReleaseNotes(releasesNotes []string) {
-	utils.Info("HELM Updating the Chart Release notes")
+func updateChartReleaseNotes(releaseNotes []string) {
+	utils.Info("HELM Updating chart release notes")
 	chart, err := chartutil.LoadChartfile(HelmChartPath)
-	utils.CheckIfError(err, "HELM Could not Load Chart to update release notes %s", HelmChartPath)
-	for i := range releasesNotes {
-		releasesNotes[i] = fmt.Sprintf("- %q", releasesNotes[i])
-	}
-	releaseNoteString := strings.Join(releasesNotes, "\n")
-	utils.Info("HELM Release note string %s", releaseNoteString)
-	chart.Annotations["artifacthub.io/changes"] = releaseNoteString
+	utils.CheckIfError(err, "HELM Failed to load chart manifest: %s", HelmChartPath)
+
+	releaseNotesBytes, err := yaml.Marshal(releaseNotes)
+	utils.CheckIfError(err, "HELM Failed to marshal release notes")
+
+	releaseNotesString := string(releaseNotesBytes)
+	utils.Info("HELM Chart release notes:\n%s", releaseNotesString)
+	chart.Annotations["artifacthub.io/changes"] = releaseNotesString
+
+	utils.Info("HELM Saving chart release notes")
 	err = chartutil.SaveChartfile(HelmChartPath, chart)
-	utils.CheckIfError(err, "HELM Saving updated release notes for Chart")
+	utils.CheckIfError(err, "HELM Failed to save chart manifest: %s", HelmChartPath)
 }
 
 // UpdateChartValue Updates the Helm ChartValue
diff --git a/magefiles/steps/release.go b/magefiles/steps/release.go
index 4cb8b40bd..b6d46336a 100644
--- a/magefiles/steps/release.go
+++ b/magefiles/steps/release.go
@@ -74,7 +74,7 @@ func (Release) NewReleaseFromOld(version, oldversion string) {
 func (Release) E2EDocs() {
 	e2edocs, err := utils.GenerateE2EDocs()
 	utils.CheckIfError(err, "error on template")
-	err = os.WriteFile("docs/e2e-tests.md", []byte(e2edocs), 644)
+	err = os.WriteFile("docs/e2e-tests.md", []byte(e2edocs), 0644)
 	utils.CheckIfError(err, "Could not write new e2e test file ")
 }
 
@@ -158,7 +158,7 @@ func updateIndexMD(old, new string) error {
 	utils.CheckIfError(err, "Could not read INDEX_DOCS file %s", INDEX_DOCS)
 	datString := string(data)
 	datString = strings.Replace(datString, old, new, -1)
-	err = os.WriteFile(INDEX_DOCS, []byte(datString), 644)
+	err = os.WriteFile(INDEX_DOCS, []byte(datString), 0644)
 	if err != nil {
 		utils.ErrorF("Could not write new %s %s", INDEX_DOCS, err)
 		return err
@@ -255,7 +255,7 @@ func makeReleaseNotes(newVersion, oldVersion string) (*utils.ReleaseNote, error)
 
 	// the newControllerVersion should match the latest tag
 	if newControllerVersion != allControllerTags[0] {
-		return nil, errors.New(fmt.Sprintf("Generating release new version %s didnt match the current latest tag %s", newControllerVersion, allControllerTags[0]))
+		return nil, fmt.Errorf("generating release new version %s didnt match the current latest tag %s", newControllerVersion, allControllerTags[0])
 	}
 	// previous version
 	newReleaseNotes.PreviousControllerVersion = allControllerTags[1]
@@ -272,8 +272,8 @@ func makeReleaseNotes(newVersion, oldVersion string) (*utils.ReleaseNote, error)
 	var allUpdates []string
 	var depUpdates []string
 	var helmUpdates []string
-	prRegex := regexp.MustCompile("\\(#\\d+\\)")
-	depBot := regexp.MustCompile("^(\\w){1,10} Bump ")
+	prRegex := regexp.MustCompile(`\(#\d+\)`)
+	depBot := regexp.MustCompile(`^(\w){1,10} Bump `)
 	helmRegex := regexp.MustCompile("helm|chart")
 	for i, s := range commits {
 		// matches on PR
@@ -322,13 +322,13 @@ func makeReleaseNotes(newVersion, oldVersion string) (*utils.ReleaseNote, error)
 	controllerDigest := utils.FindImageDigest(data, "controller", newVersion)
 	if len(controllerDigest) == 0 {
 		utils.ErrorF("Controller Digest could not be found")
-		return nil, errors.New("Controller digest could not be found")
+		return nil, errors.New("controller digest could not be found")
 	}
 
 	controllerChrootDigest := utils.FindImageDigest(data, "controller-chroot", newVersion)
 	if len(controllerChrootDigest) == 0 {
 		utils.ErrorF("Controller Chroot Digest could not be found")
-		return nil, errors.New("Controller Chroot digest could not be found")
+		return nil, errors.New("controller chroot digest could not be found")
 	}
 
 	utils.Debug("Latest Controller Digest %v", controllerDigest)