feat: more detailed gitops pr commit msg (#202)

Co-authored-by: Nick Schaap <schaap@adobe.com>

Author: nickschaap

gitops/commitmsg/commitmsg.go

@@ -40,10 +40,16 @@ func ExtractTargets(msg string) (packages []string) {
 	return
 }
 
-// Generate generates a commit message from a list of targets
-func Generate(targets []string) string {
+// Generate generates a commit message from a list of targets, including git branch and commit info above the targets block
+func Generate(targets []string, branchName, gitCommit string) string {
 	var sb strings.Builder
 	sb.WriteByte('\n')
+	sb.WriteString("Branch: ")
+	sb.WriteString(branchName)
+	sb.WriteByte('\n')
+	sb.WriteString("Commit: ")
+	sb.WriteString(gitCommit)
+	sb.WriteByte('\n')
 	sb.WriteString(begin)
 	sb.WriteByte('\n')
 

gitops/commitmsg/commitmsg_test.go

@@ -21,7 +21,7 @@ import (
 
 func TestRoundtrip(t *testing.T) {
 	targets := []string{"target1", "target2"}
-	msg := commitmsg.Generate(targets)
+	msg := commitmsg.Generate(targets, "my-branch", "abc123")
 	t2 := commitmsg.ExtractTargets(msg)
 	if !reflect.DeepEqual(targets, t2) {
 		t.Errorf("Unexpected targets after parsing: %v", t2)
@@ -30,9 +30,11 @@ func TestRoundtrip(t *testing.T) {
 
 func ExampleGenerate() {
 	targets := []string{"target1", "target2"}
-	msg := commitmsg.Generate(targets)
+	msg := commitmsg.Generate(targets, "my-branch", "abc123")
 	fmt.Println(msg)
 	// Output:
+	// Branch: my-branch
+	// Commit: abc123
 	// --- gitops targets begin ---
 	// target1
 	// target2

gitops/prer/create_gitops_prs.go

@@ -211,7 +211,7 @@ func main() {
 				}
 			}
 		}
-		if workdir.Commit(fmt.Sprintf("GitOps for release branch %s from %s commit %s\n%s", *releaseBranch, *branchName, *gitCommit, commitmsg.Generate(targets)), *gitopsPath) {
+		if workdir.Commit(fmt.Sprintf("GitOps for release branch %s from %s commit %s\n%s", *releaseBranch, *branchName, *gitCommit, commitmsg.Generate(targets, *branchName, *gitCommit)), *gitopsPath) {
 			log.Println("branch", branch, "has changes, push is required")
 			updatedGitopsBranches = append(updatedGitopsBranches, branch)
 		}