Do not strip underscores from changes descriptions

Signed-off-by: Sergio Castaño Arteaga <tegioz@icloud.com>

Author: tegioz

internal/pkg/manager.go

@@ -301,7 +301,7 @@ func (m *Manager) Register(ctx context.Context, pkg *hub.Package) error {
 
 	// Strip markdown from changes entries description
 	for _, change := range pkg.Changes {
-		change.Description = stripmd.Strip(change.Description)
+		change.Description = stripChangeDescription(change.Description)
 	}
 
 	// Register package in database
@@ -443,3 +443,22 @@ func areValidCapabilities(capabilities string) bool {
 	}
 	return false
 }
+
+// stripChangeDescription removes markdown while preserving underscores.
+func stripChangeDescription(description string) string {
+	// Fast path for descriptions without underscores
+	if !strings.Contains(description, "_") {
+		return stripmd.Strip(description)
+	}
+
+	// Protect underscores before stripping markdown
+	token := "UNDERSCORETOKEN"
+	for strings.Contains(description, token) {
+		token += "X"
+	}
+	protected := strings.ReplaceAll(description, "_", token)
+
+	// Strip markdown and restore underscores
+	stripped := stripmd.Strip(protected)
+	return strings.ReplaceAll(stripped, token, "_")
+}

internal/pkg/manager_test.go

@@ -1564,3 +1564,32 @@ func TestParseKey(t *testing.T) {
 		})
 	}
 }
+
+func TestStripChangeDescription(t *testing.T) {
+	t.Parallel()
+
+	testCases := []struct {
+		description string
+		expected    string
+	}{
+		{
+			description: "Suppress CONFIG_OPTION_NAME warning and *bold* text",
+			expected:    "Suppress CONFIG_OPTION_NAME warning and bold text",
+		},
+		{
+			description: "No markdown or underscores here",
+			expected:    "No markdown or underscores here",
+		},
+		{
+			description: "Token collision UNDERSCORETOKEN and CONFIG_OPTION_NAME",
+			expected:    "Token collision UNDERSCORETOKEN and CONFIG_OPTION_NAME",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.description, func(t *testing.T) {
+			t.Parallel()
+			assert.Equal(t, tc.expected, stripChangeDescription(tc.description))
+		})
+	}
+}