Improve comment for githubpullrequestcomment

Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>

Author: matheuscscp

docs/spec/v1beta3/providers.md

@@ -2125,21 +2125,23 @@ The provider posts comments in the following format:
 ```markdown
 ## Flux Status
 
-ℹ️ Info: `Kustomization/flux-system.flux-system`
+ℹ️ Kustomization/flux-system/flux-system
 
-`Applied revision: main@sha1:abc1234`
+Applied revision: main@sha1:abc1234
 
-* `revision`: `main@sha1:abc1234`
+Metadata:
+* `revision`: main@sha1:abc1234
 ```
 
 For error events, the comment will show:
 
 ```markdown
 ## Flux Status
 
-⚠️ Error: `Kustomization/flux-system.flux-system`
+⚠️ Kustomization/flux-system/flux-system
 
-`Reconciliation failed: validation error`
+Reconciliation failed: validation error
 
-* `revision`: `main@sha1:abc1234`
+Metadata:
+* `revision`: main@sha1:abc1234
 ```

internal/notifier/github_pull_request_comment.go

@@ -163,12 +163,12 @@ func (g *GitHubPullRequestComment) formatCommentKeyMarker(event *eventv1.Event)
 func (g *GitHubPullRequestComment) formatCommentBody(event *eventv1.Event) string {
 	marker := g.formatCommentKeyMarker(event)
 
-	// Format severity with emoji
-	var severityText string
+	// Get emoji based on severity
+	var severityEmoji string
 	if event.Severity == eventv1.EventSeverityError {
-		severityText = "⚠️ Error"
+		severityEmoji = "⚠️"
 	} else {
-		severityText = "ℹ️ Info"
+		severityEmoji = "ℹ️"
 	}
 
 	// Format object identifier
@@ -187,10 +187,10 @@ func (g *GitHubPullRequestComment) formatCommentBody(event *eventv1.Event) strin
 	slices.Sort(keys)
 	var metadataLines strings.Builder
 	for _, key := range keys {
-		fmt.Fprintf(&metadataLines, "* `%s`: `%s`\n", key, event.Metadata[key])
+		fmt.Fprintf(&metadataLines, "* `%s`: %s\n", key, event.Metadata[key])
 	}
 
 	// Format the comment body
-	return fmt.Sprintf("%s\n\n## Flux Status\n\n%s: `%s`\n\n`%s`\n\n%s",
-		marker, severityText, objectID, event.Message, metadataLines.String())
+	return fmt.Sprintf("%s\n\n## Flux Status\n\n%s %s\n\n%s\n\nMetadata:\n%s",
+		marker, severityEmoji, objectID, event.Message, metadataLines.String())
 }