feat: abra release now asks for a release note (!393)

This implements coop-cloud/organising#540 by checking if a`release/next` file exists and if so moves it to `release/<tag>`. When no release notes exists it prompts for them.

Reviewed-on: coop-cloud/abra#393
Reviewed-by: moritz <moritz.m@local-it.org>
Co-authored-by: p4u1 <p4u1_f4u1@riseup.net>
Co-committed-by: p4u1 <p4u1_f4u1@riseup.net>

cli/recipe/release.go

@@ -1,7 +1,9 @@
 package recipe
 
 import (
+	"errors"
 	"fmt"
+	"os"
 	"path"
 	"strconv"
 	"strings"
@@ -140,7 +142,7 @@ your SSH keys configured on your account.
 
 // getImageVersions retrieves image versions for a recipe
 func getImageVersions(recipe recipe.Recipe) (map[string]string, error) {
-	var services = make(map[string]string)
+	services := make(map[string]string)
 
 	missingTag := false
 	for _, service := range recipe.Config.Services {
@@ -207,6 +209,10 @@ func createReleaseFromTag(recipe recipe.Recipe, tagString, mainAppVersion string
 		tagString = fmt.Sprintf("%s+%s", tag.String(), mainAppVersion)
 	}
 
+	if err := addReleaseNotes(recipe, tagString); err != nil {
+		logrus.Fatal(err)
+	}
+
 	if err := commitRelease(recipe, tagString); err != nil {
 		logrus.Fatal(err)
 	}
@@ -237,6 +243,82 @@ func getTagCreateOptions(tag string) (git.CreateTagOptions, error) {
 	return git.CreateTagOptions{Message: msg}, nil
 }
 
+// addReleaseNotes checks if the release/next release note exists and moves the
+// file to release/<tag>.
+func addReleaseNotes(recipe recipe.Recipe, tag string) error {
+	repoPath := path.Join(config.RECIPES_DIR, recipe.Name)
+	tagReleaseNotePath := path.Join(repoPath, "release", tag)
+	if _, err := os.Stat(tagReleaseNotePath); err == nil {
+		// Release note for current tag already exist exists.
+		return nil
+	} else if !errors.Is(err, os.ErrNotExist) {
+		return err
+	}
+
+	nextReleaseNotePath := path.Join(repoPath, "release", "next")
+	if _, err := os.Stat(nextReleaseNotePath); err == nil {
+		// release/next note exists. Move it to release/<tag>
+		if internal.Dry {
+			logrus.Debugf("dry run: move release note from 'next' to %s", tag)
+			return nil
+		}
+		if !internal.NoInput {
+			prompt := &survey.Input{
+				Message: "Use release note in release/next?",
+			}
+			var addReleaseNote bool
+			if err := survey.AskOne(prompt, &addReleaseNote); err != nil {
+				return err
+			}
+			if !addReleaseNote {
+				return nil
+			}
+		}
+		err := os.Rename(nextReleaseNotePath, tagReleaseNotePath)
+		if err != nil {
+			return err
+		}
+		err = gitPkg.Add(repoPath, path.Join("release", "next"), internal.Dry)
+		if err != nil {
+			return err
+		}
+		err = gitPkg.Add(repoPath, path.Join("release", tag), internal.Dry)
+		if err != nil {
+			return err
+		}
+	} else if !errors.Is(err, os.ErrNotExist) {
+		return err
+	}
+
+	// No release note exists for the current release.
+	if internal.NoInput {
+		return nil
+	}
+
+	prompt := &survey.Input{
+		Message: "Release Note (leave empty for no release note)",
+	}
+	var releaseNote string
+	if err := survey.AskOne(prompt, &releaseNote); err != nil {
+		return err
+	}
+
+	if releaseNote == "" {
+		return nil
+	}
+
+	err := os.WriteFile(tagReleaseNotePath, []byte(releaseNote), 0o644)
+	if err != nil {
+		return err
+	}
+	err = gitPkg.Add(repoPath, path.Join("release", tag), internal.Dry)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func commitRelease(recipe recipe.Recipe, tag string) error {
 	if internal.Dry {
 		logrus.Debugf("dry run: no changes committed")
@@ -404,6 +486,10 @@ func createReleaseFromPreviousTag(tagString, mainAppVersion string, recipe recip
 		}
 	}
 
+	if err := addReleaseNotes(recipe, tagString); err != nil {
+		logrus.Fatal(err)
+	}
+
 	if err := commitRelease(recipe, tagString); err != nil {
 		logrus.Fatalf("failed to commit changes: %s", err.Error())
 	}