fix: Use language repo's commit value as the source_commit_hash (#2078)

Fixes: #2066

Author: lqiu96

internal/conventionalcommits/conventional_commits.go

@@ -45,7 +45,7 @@ type ConventionalCommit struct {
 	// IsNested indicates if the commit is a nested commit.
 	IsNested bool `yaml:"-" json:"-"`
 	// SHA is the full commit hash.
-	SHA string `yaml:"-" json:"-"`
+	SHA string `yaml:"-" json:"source_commit_hash,omitempty"`
 	// When is the timestamp of the commit.
 	When time.Time `yaml:"-" json:"-"`
 }
@@ -55,12 +55,10 @@ func (c *ConventionalCommit) MarshalJSON() ([]byte, error) {
 	type Alias ConventionalCommit
 	return json.Marshal(&struct {
 		*Alias
-		PiperCLNumber    string `json:"piper_cl_number,omitempty"`
-		SourceCommitHash string `json:"source_commit_hash,omitempty"`
+		PiperCLNumber string `json:"piper_cl_number,omitempty"`
 	}{
-		Alias:            (*Alias)(c),
-		PiperCLNumber:    c.Footers["PiperOrigin-RevId"],
-		SourceCommitHash: c.Footers["git-commit-hash"],
+		Alias:         (*Alias)(c),
+		PiperCLNumber: c.Footers["PiperOrigin-RevId"],
 	})
 }
 
@@ -168,6 +166,8 @@ const (
 	endNestedCommit     = "END_NESTED_COMMIT"
 )
 
+// extractCommitMessageOverride searches through the commit message
+// and parses for the text between the commit override tags.
 func extractCommitMessageOverride(message string) string {
 	beginIndex := strings.Index(message, beginCommitOverride)
 	if beginIndex == -1 {

internal/conventionalcommits/conventional_commits_test.go

@@ -261,7 +261,7 @@ END_NESTED_COMMIT
 					LibraryID: "example-id",
 					IsNested:  false,
 					Footers:   map[string]string{},
-					SHA:       sha.String(),
+					SHA:       sha.String(), // For each nested commit, the SHA should be the same (points to language repo's commit hash)
 					When:      now,
 				},
 				{
@@ -272,7 +272,7 @@ END_NESTED_COMMIT
 					LibraryID: "example-id",
 					IsNested:  true,
 					Footers:   map[string]string{},
-					SHA:       sha.String(),
+					SHA:       sha.String(), // For each nested commit, the SHA should be the same (points to language repo's commit hash)
 					When:      now,
 				},
 				{
@@ -283,12 +283,11 @@ END_NESTED_COMMIT
 					LibraryID: "example-id",
 					IsNested:  true,
 					Footers:   map[string]string{},
-					SHA:       sha.String(),
+					SHA:       sha.String(), // For each nested commit, the SHA should be the same (points to language repo's commit hash)
 					When:      now,
 				},
 			},
 		},
-
 		{
 			name: "commit with empty nested commit",
 			message: `feat(parser): main feature
@@ -341,7 +340,6 @@ PiperOrigin-RevId: 654321
 Source-link: fake-link
 END_NESTED_COMMIT
 END_COMMIT_OVERRIDE
-
 `,
 			want: []*ConventionalCommit{
 				{
@@ -351,7 +349,7 @@ END_COMMIT_OVERRIDE
 					LibraryID: "example-id",
 					IsNested:  true,
 					Footers:   map[string]string{"PiperOrigin-RevId": "123456", "Source-link": "fake-link"},
-					SHA:       sha.String(),
+					SHA:       sha.String(), // For each nested commit, the SHA should be the same (points to language repo's commit hash)
 					When:      now,
 				},
 				{
@@ -361,7 +359,7 @@ END_COMMIT_OVERRIDE
 					Body:      "body of nested commit 2\n...",
 					LibraryID: "example-id",
 					Footers:   map[string]string{"PiperOrigin-RevId": "654321", "Source-link": "fake-link"},
-					SHA:       sha.String(),
+					SHA:       sha.String(), // For each nested commit, the SHA should be the same (points to language repo's commit hash)
 					When:      now,
 				},
 			},
@@ -491,14 +489,14 @@ func TestConventionalCommit_MarshalJSON(t *testing.T) {
 		Body:    "body of feature",
 		Footers: map[string]string{
 			"PiperOrigin-RevId": "12345",
-			"git-commit-hash":   "abcdef123456",
 		},
+		SHA: "1234",
 	}
 	b, err := c.MarshalJSON()
 	if err != nil {
 		t.Fatalf("MarshalJSON() failed: %v", err)
 	}
-	want := `{"type":"feat","subject":"new feature","body":"body of feature","piper_cl_number":"12345","source_commit_hash":"abcdef123456"}`
+	want := `{"type":"feat","subject":"new feature","body":"body of feature","source_commit_hash":"1234","piper_cl_number":"12345"}`
 	if diff := cmp.Diff(want, string(b)); diff != "" {
 		t.Errorf("MarshalJSON() mismatch (-want +got):\n%s", diff)
 	}

internal/docker/docker_test.go

@@ -839,8 +839,8 @@ func TestReleaseInitRequestContent(t *testing.T) {
 						Body:    "body of feature",
 						Footers: map[string]string{
 							"PiperOrigin-RevId": "12345",
-							"git-commit-hash":   "abcdef123456",
 						},
+						SHA: "1234",
 					},
 				},
 			},
@@ -875,7 +875,7 @@ func TestReleaseInitRequestContent(t *testing.T) {
 			t.Fatalf("ReadFile failed: %v", err)
 		}
 
-		wantFile := filepath.Join("testdata", "release-init-request", "release-init-request.json")
+		wantFile := filepath.Join("..", "..", "testdata", "docker", "release-init-request", "release-init-request.json")
 		wantBytes, err := os.ReadFile(wantFile)
 		if err != nil {
 			t.Fatalf("ReadFile for want file failed: %v", err)

…e-init-request/release-init-request.json …e-init-request/release-init-request.jsoninternal/docker/testdata/release-init-request/release-init-request.json renamed to testdata/docker/release-init-request/release-init-request.json internal/docker/testdata/release-init-request/release-init-request.json renamed to testdata/docker/release-init-request/release-init-request.json

@@ -10,8 +10,8 @@
           "type": "feat",
           "subject": "new feature",
           "body": "body of feature",
-          "piper_cl_number": "12345",
-          "source_commit_hash": "abcdef123456"
+          "source_commit_hash": "1234",
+          "piper_cl_number": "12345"
         }
       ],
       "apis": null,
@@ -21,4 +21,4 @@
       "release_triggered": true
     }
   ]
-}
+}