fix(feed): use meaningful lines as comment excerpt (#39276)

Comment excerpts in activity feeds previously used either the first 200
display characters of a comment or, for review comments, its first
physical line. That excerpt is rendered as Markdown in the feed, so if
the excerpt began with a leading blank lines or structural markdown
syntax, the excerpt would render as empty or produce broken output. For
example, a review comment beginning with a code fence stored only the
opening fence, which rendered as an empty code block.

This commit instead renders feed excerpts as prose only, dropping code,
math, tables, images and HTML, which also fixes already stored excerpts.
New excerpts start at the first prose line, and review comments get the
same excerpt as issue comments.

This produces meaningful excerpts in more cases while preserving their
original Markdown.

---

For a comment that contains the following:

````
```
some code
```

hello
````

This previously rendered as:
 
<img width="816" height="118" alt="Screenshot 2026-09-08 at 5 06 47 PM"
src="https://github.com/user-attachments/assets/9d125363-72de-46bf-b47a-961245a79c5f"
/>

And now renders as:

<img width="807" height="89" alt="Screenshot 2026-09-08 at 5 08 30 PM"
src="https://github.com/user-attachments/assets/d2dcdc6d-d7a9-437f-8e9c-b845fe99fa5e"
/>

---------

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: bircni <bircni@icloud.com>
This commit is contained in:
Sergio Benitez
2026-09-25 03:08:15 +00:00
committed by GitHub
co-authored by silverwind bircni
parent 03058691c3
commit 722e52334a
11 changed files with 129 additions and 30 deletions
+12 -2
View File
@@ -190,14 +190,24 @@ func reactionToEmoji(reaction string) template.HTML {
return template.HTML(fmt.Sprintf(`<img alt=":%s:" src="%s/assets/img/emoji/%s.png"></img>`, reaction, setting.StaticURLPrefix, url.PathEscape(reaction)))
}
func (ut *RenderUtils) MarkdownToHtml(input string) template.HTML {
output, err := markdown.RenderString(markup.NewRenderContext(ut.ctx).WithMetas(markup.ComposeSimpleDocumentMetas()), input)
func (ut *RenderUtils) renderMarkdownToHtml(input string, feedExcerpt bool) template.HTML {
rctx := markup.NewRenderContext(ut.ctx).WithMetas(markup.ComposeSimpleDocumentMetas())
rctx.RenderOptions.FeedExcerpt = feedExcerpt
output, err := markdown.RenderString(rctx, input)
if err != nil {
log.Error("RenderString: %v", err)
}
return output
}
func (ut *RenderUtils) MarkdownToHtml(input string) template.HTML {
return ut.renderMarkdownToHtml(input, false)
}
func (ut *RenderUtils) FeedExcerptToHtml(input string) template.HTML {
return ut.renderMarkdownToHtml(input, true)
}
// RenderPackageMarkdown renders package page Markdown so relative links resolve against the
// linked repository's default branch instead of the site root, falling back to plain rendering
// when there is no linked repository. pkgTreePath optionally roots links in a subdirectory
+19
View File
@@ -242,6 +242,25 @@ com 88fc37a3c0a4dda553bdcfc80c178a58247f42fb mit
space</p>
`
assert.Equal(t, expected, string(newTestRenderUtils(t).MarkdownToHtml(testInput())))
defer test.MockVariableValue(&setting.Markdown.MathCodeBlockOptions, setting.MarkdownMathCodeBlockOptions{ParseBlockDollar: true})()
for _, tc := range []struct {
name string
input string
expected string
}{
{name: "code", input: "```suggestion\nreplacement\n```\n\nexplanation", expected: "<p>explanation</p>\n"},
{name: "unclosed code", input: "```suggestion"},
{name: "table", input: "| a | b |\n|---|---|\n| 1 | 2 |"},
{name: "math", input: "$$\nx\n$$\nafter", expected: "<p>after</p>\n"},
{name: "image", input: "![img](https://x/y.png)\n\ncaption", expected: "<p>caption</p>\n"},
{name: "linked image", input: "[![img](https://x/y.png)](https://example.com)"},
{name: "html", input: "<details>\n<summary>x</summary>\n\nbody\n</details>", expected: "<p>body</p>\n"},
} {
t.Run(tc.name, func(t *testing.T) {
assert.Equal(t, tc.expected, string(newTestRenderUtils(t).FeedExcerptToHtml(tc.input)))
})
}
}
func TestRenderPackageMarkdown(t *testing.T) {