Merge pull request #3684 from npolshakova/fix-sig-label-map-replacement

Add sig labels to markdown
kubernetes · Jul 18, 2024 · dbda6e5 · dbda6e5
2 parents 076b3d5 + eddbe0e
commit dbda6e5
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/pkg/notes/maps/testdata/unit/maps.yaml b/pkg/notes/maps/testdata/unit/maps.yaml
@@ -48,3 +48,12 @@ datafields:
     - kubectl
     - apiserver
     name: "Modifying release note areas"
+---
+pr: 95000
+releasenote:
+  text: "This test string has been modified"
+datafields:
+  testcase:
+    property: "Markdown"
+    expected: "This test string has been modified (#95000, @arghya88) [SIG Instrumentation and Scheduling]"
+    name: "Modifying release note markdown"
diff --git a/pkg/notes/notes.go b/pkg/notes/notes.go
@@ -478,7 +478,8 @@ func (g *Gatherer) ReleaseNoteFromCommit(result *Result) (*ReleaseNote, error) {
 	authorURL := pr.GetUser().GetHTMLURL()
 	prURL := pr.GetHTMLURL()
 	isFeature := hasString(labelsWithPrefix(pr, "kind"), "feature")
-	noteSuffix := prettifySIGList(labelsWithPrefix(pr, "sig"))
+	sigLabels := labelsWithPrefix(pr, "sig")
+	noteSuffix := prettifySIGList(sigLabels)
 
 	isDuplicateSIG := false
 	if len(labelsWithPrefix(pr, "sig")) > 1 {
@@ -515,7 +516,7 @@ func (g *Gatherer) ReleaseNoteFromCommit(result *Result) (*ReleaseNote, error) {
 		AuthorURL:      authorURL,
 		PrURL:          prURL,
 		PrNumber:       pr.GetNumber(),
-		SIGs:           labelsWithPrefix(pr, "sig"),
+		SIGs:           sigLabels,
 		Kinds:          labelsWithPrefix(pr, "kind"),
 		Areas:          labelsWithPrefix(pr, "area"),
 		Feature:        isFeature,
@@ -1224,6 +1225,10 @@ func (rn *ReleaseNote) ApplyMap(noteMap *ReleaseNotesMap, markdownLinks bool) er
 			markdown = fmt.Sprintf("%s ([#%d](%s), [@%s](%s))",
 				indented, rn.PrNumber, rn.PrURL, rn.Author, rn.AuthorURL)
 		}
+		// Add sig labels to markdown
+		if rn.SIGs != nil {
+			markdown = fmt.Sprintf("%s [%s]", markdown, prettifySIGList(rn.SIGs))
+		}
 		// Uppercase the first character of the markdown to make it look uniform
 		rn.Markdown = capitalizeString(markdown)
 	}

diff --git a/pkg/notes/notes_map_test.go b/pkg/notes/notes_map_test.go
@@ -46,7 +46,7 @@ func TestNewProviderFromInitString(t *testing.T) {
 func TestParseReleaseNotesMap(t *testing.T) {
 	maps, err := ParseReleaseNotesMap("maps/testdata/unit/maps.yaml")
 	require.Nil(t, err)
-	require.GreaterOrEqual(t, 5, len(*maps))
+	require.GreaterOrEqual(t, 6, len(*maps))
 
 	maps, err = ParseReleaseNotesMap("maps/testdata/fullmap.yaml")
 	require.Nil(t, err)
@@ -59,7 +59,7 @@ func TestGetMapsForPR(t *testing.T) {
 
 	maps, err := provider.GetMapsForPR(95000)
 	require.Nil(t, err)
-	require.GreaterOrEqual(t, 5, len(maps))
+	require.GreaterOrEqual(t, 6, len(maps))
 
 	maps, err = provider.GetMapsForPR(123)
 	require.Nil(t, err)

diff --git a/pkg/notes/notes_v2.go b/pkg/notes/notes_v2.go
@@ -167,7 +167,8 @@ func (g *Gatherer) buildReleaseNote(pair *commitPrPair) (*ReleaseNote, error) {
 	authorURL := pr.GetUser().GetHTMLURL()
 	prURL := pr.GetHTMLURL()
 	isFeature := hasString(labelsWithPrefix(pr, "kind"), "feature")
-	noteSuffix := prettifySIGList(labelsWithPrefix(pr, "sig"))
+	sigLabels := labelsWithPrefix(pr, "sig")
+	noteSuffix := prettifySIGList(sigLabels)
 
 	isDuplicateSIG := false
 	if len(labelsWithPrefix(pr, "sig")) > 1 {
@@ -204,7 +205,7 @@ func (g *Gatherer) buildReleaseNote(pair *commitPrPair) (*ReleaseNote, error) {
 		AuthorURL:      authorURL,
 		PrURL:          prURL,
 		PrNumber:       pr.GetNumber(),
-		SIGs:           labelsWithPrefix(pr, "sig"),
+		SIGs:           sigLabels,
 		Kinds:          labelsWithPrefix(pr, "kind"),
 		Areas:          labelsWithPrefix(pr, "area"),
 		Feature:        isFeature,