chore: use markdown to display github comments truncation header (#4885)

benoittoulme · chenrui333 · web-flow · commit 6b52bd773830 · 2024-09-12T16:00:11.000-04:00
Co-authored-by: Rui Chen &lt;rui@chenrui.dev&gt;
diff --git a/server/events/vcs/github_client.go b/server/events/vcs/github_client.go
@@ -232,8 +232,8 @@ func (g *GithubClient) CreateComment(logger logging.SimpleLogging, repo models.R
 			"```diff\n"
 	}
 
-	truncationHeader := "\n```\n</details>" +
-		"\n<br>\n\n**Warning**: Command output is larger than the maximum number of comments per command. Output truncated.\n\n[..]\n"
+	truncationHeader := "> [!WARNING]\n" +
+		"> **Warning**: Command output is larger than the maximum number of comments per command. Output truncated.\n"
 
 	comments := common.SplitComment(comment, maxCommentLength, sepEnd, sepStart, g.maxCommentsPerCommand, truncationHeader)
 	for i := range comments {

Original file line number	Diff line number	Diff line change
`@@ -232,8 +232,8 @@ func (g *GithubClient) CreateComment(logger logging.SimpleLogging, repo models.R`
`232`	`232`	"```diff\n"
`233`	`233`	`}`
`234`	`234`
`235`		- truncationHeader := "\n```\n</details>" +
`236`		`- "\n<br>\n\nWarning: Command output is larger than the maximum number of comments per command. Output truncated.\n\n[..]\n"`
	`235`	`+ truncationHeader := "> [!WARNING]\n" +`
	`236`	`+ "> Warning: Command output is larger than the maximum number of comments per command. Output truncated.\n"`
`237`	`237`
`238`	`238`	`comments := common.SplitComment(comment, maxCommentLength, sepEnd, sepStart, g.maxCommentsPerCommand, truncationHeader)`
`239`	`239`	`for i := range comments {`