Adding support for markdown in checks description #17980

Caellion · 2021-12-14T12:02:08Z

They say image is worth a thousand words, so let me say, provides this:

codecov-commenter · 2021-12-14T14:19:43Z

Codecov Report

Merging #17980 (fd082dc) into main (b4782e2) will decrease coverage by 0.02%.
The diff coverage is 2.75%.

@@            Coverage Diff             @@
##             main   #17980      +/-   ##
==========================================
- Coverage   45.31%   45.28%   -0.03%     
==========================================
  Files         819      820       +1     
  Lines       90863    90939      +76     
==========================================
+ Hits        41173    41186      +13     
- Misses      43134    43197      +63     
  Partials     6556     6556

Impacted Files	Coverage Δ
cmd/admin.go	`0.00% <0.00%> (ø)`
models/user/external_login_user.go	`30.26% <0.00%> (+6.55%)`	⬆️
routers/web/admin/auths.go	`47.71% <0.00%> (-0.51%)`	⬇️
routers/web/user/auth.go	`11.57% <0.00%> (-0.48%)`	⬇️
routers/web/user/auth_openid.go	`0.00% <0.00%> (ø)`
services/auth/source/oauth2/providers_custom.go	`60.56% <0.00%> (-2.68%)`	⬇️
services/auth/source/oauth2/providers_openid.go	`44.44% <0.00%> (-8.89%)`	⬇️
services/auth/source/oauth2/providers_simple.go	`40.00% <0.00%> (-2.31%)`	⬇️
services/auth/source/oauth2/source.go	`25.00% <ø> (ø)`
services/externalaccount/link.go	`0.00% <0.00%> (ø)`
... and 13 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 790e6cf...fd082dc. Read the comment docs.

lunny · 2021-12-14T16:18:10Z

Looks like a good idea but even Github just stored text and most of them are short.

Caellion · 2021-12-14T16:34:52Z

I agree it might be a specific use case but I use jenkins with checks plugin and it seems warnings-ng publishes analysis results as markdown tables.

templates/repo/commit_statuses.tmpl

templates/repo/pulls/status.tmpl

web_src/less/_base.less

integrations/private-testing.key

Co-authored-by: silverwind <me@silverwind.io>

* https://github.com/go-gitea/gitea: [skip ci] Updated translations via Crowdin Use non-expiring key. (go-gitea#17984) Co-Authored-By: silverwind <me@silverwind.io>

Co-authored-by: silverwind <me@silverwind.io>

* 'main' of https://github.com/Caellion/gitea: Update web_src/less/_base.less Update templates/repo/pulls/status.tmpl Update templates/repo/commit_statuses.tmpl

lunny · 2021-12-15T02:04:11Z

I agree it might be a specific use case but I use jenkins with checks plugin and it seems warnings-ng publishes analysis results as markdown tables.

Yeah, so the UI should consider both long markdown content and short plain content

modules/templates/helper.go

templates/repo/commit_statuses.tmpl

modules/templates/helper.go

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

modules/templates/helper.go

…kup.Sanitize(raw))` in `Markdown2html`

Co-authored-by: silverwind <me@silverwind.io>

zeripath · 2021-12-17T21:44:19Z

I think we need to add something to the rendercontext here - for example I think it's likely that SHAs will be in these reports and you'll want to link to them.

To that end we need to pass the repo and urlmetas

Caellion · 2021-12-17T22:08:08Z

I think we need to add something to the rendercontext here - for example I think it's likely that SHAs will be in these reports and you'll want to link to them.

To that end we need to pass the repo and urlmetas

Actually from what I have seen any links that might happen to be in the reports lead to the CI that generated them (for example to the build) rather than to somewhere in repo.

lunny · 2022-02-02T10:06:16Z

modules/templates/helper.go

+		}
+		return template.HTML(markup.Sanitize(renderedContent))
+	} else if markupType == "markup" {
+		if renderedContent, err = markup.RenderString(&markup.RenderContext{}, raw); err != nil {


This has already included markdown rendering.

And it seems we just needs markdown here.

It was requested by sliverwind . #17980 (review)

Personally I also prefer to keep it simple and only introduce one render.

Yeah, I guess we can actually simplify and only support markdown, at least until we can detect other types (like RST) based on entered content.

By the way, is there speaking anything against just using Str2html?

AFAIR it didn't render markdown tables

Yeah seems like Str2html is mislabeled and actually renders HTML strings into template.HMTL, so markdown.RenderString seems fine.

* 'main' of https://github.com/go-gitea/gitea: (87 commits) Fix template bug of LFS lock (go-gitea#18784) Various Mermaid improvements (go-gitea#18776) [skip ci] Updated translations via Crowdin Fix display time of milestones (go-gitea#18753) [skip ci] Updated translations via Crowdin Prevent dangling GetAttribute calls (go-gitea#18754) Add example to render html files (go-gitea#18736) Fix a broken link in `commits_list_small.tmpl` (go-gitea#18763) Fix broken cancel button link on patch page (go-gitea#18718) Ignore the migrate if u2f_registration is not exist (go-gitea#18760) [skip ci] Updated translations via Crowdin Increase the size of the webauthn_credential credential_id field (go-gitea#18739) Fix isempty detection of git repository (go-gitea#18746) [skip ci] Updated translations via Crowdin Send mail to issue/pr assignee/reviewer also when OnMention is set (go-gitea#18707) Reduce CI go module downloads, add make targets (go-gitea#18708) Add number in queue status to monitor page (go-gitea#18712) Fix source code line highlighting (go-gitea#18729) Fix forked repositories missed tags (go-gitea#18719) [skip ci] Updated translations via Crowdin ...

techknowlogick · 2022-02-16T18:54:24Z

I'm not sure if "status" is the appropriate place for this as it could seriously increase page load size, perhaps another field such as how github does it (see "checks" page on PRs)

(I'm for collecting this information, just in a different field to keep the status lightweight)

wxiaoguang · 2022-03-31T05:24:37Z

FYI: another merged PR has introduced another RenderMarkdownToHtml

gitea/modules/templates/helper.go

Line 165 in 43332a4

"RenderMarkdownToHtml": func(input string) template.HTML {

lunny · 2022-06-04T03:44:24Z

Or we can have two columns, one is for status, another is for description which allow markdown renderering.

wxiaoguang · 2023-04-24T13:28:33Z

So this PR gets stale and I guess most people prefer to keep the "status description" as simple as possible, so the "markdown rendering" is not accepted, right?

lunny · 2023-04-24T15:35:10Z

So this PR gets stale and I guess most people prefer to keep the "status description" as simple as possible, so the "markdown rendering" is not accepted, right?

I myself couldn't find enough reason to support markdown there.

silverwind · 2023-04-24T16:04:42Z

Does GitHub support markdown there?

wxiaoguang · 2023-05-01T03:58:00Z

If I understand correctly, GitHub only shows simple text for the status. Maybe it's good to keep that field simple.

And this PR has been stale for a long time and I can't think of a way to handling it other than closing it. Feel free to reopen if there's any new progress and I could also help.

Caellion added 5 commits December 14, 2021 12:54

WIP: Add support for markdown in checks

a4bcb40

Merge branch 'main' of https://github.com/Caellion/gitea into main

9f13a65

update private key to pass tests

615028b

naming, markup class

415175d

also use markdown-supporting statuses in pop-up

6b75d44

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Dec 14, 2021

Caellion changed the title ~~WIP: Adding support for markdown in checks description~~ Adding support for markdown in checks description Dec 14, 2021

lafriks added this to the 1.17.0 milestone Dec 14, 2021

silverwind reviewed Dec 15, 2021

View reviewed changes

templates/repo/commit_statuses.tmpl Outdated Show resolved Hide resolved

silverwind reviewed Dec 15, 2021

View reviewed changes

templates/repo/pulls/status.tmpl Outdated Show resolved Hide resolved

silverwind reviewed Dec 15, 2021

View reviewed changes

web_src/less/_base.less Outdated Show resolved Hide resolved

silverwind reviewed Dec 15, 2021

View reviewed changes

integrations/private-testing.key Outdated Show resolved Hide resolved

Caellion and others added 8 commits December 15, 2021 01:28

Update templates/repo/commit_statuses.tmpl

c9e754b

Co-authored-by: silverwind <me@silverwind.io>

Update templates/repo/pulls/status.tmpl

fcf972b

Co-authored-by: silverwind <me@silverwind.io>

Update web_src/less/_base.less

c4fd589

Co-authored-by: silverwind <me@silverwind.io>

Merge https://github.com/go-gitea/gitea into upstream-master

358ba98

* https://github.com/go-gitea/gitea: [skip ci] Updated translations via Crowdin Use non-expiring key. (go-gitea#17984) Co-Authored-By: silverwind <me@silverwind.io>

Update templates/repo/commit_statuses.tmpl

aa587f5

Co-authored-by: silverwind <me@silverwind.io>

Update templates/repo/pulls/status.tmpl

d046160

Co-authored-by: silverwind <me@silverwind.io>

Update web_src/less/_base.less

8605af6

Co-authored-by: silverwind <me@silverwind.io>

Merge branch 'main' of https://github.com/Caellion/gitea

fd082dc

* 'main' of https://github.com/Caellion/gitea: Update web_src/less/_base.less Update templates/repo/pulls/status.tmpl Update templates/repo/commit_statuses.tmpl

wxiaoguang requested changes Dec 15, 2021

View reviewed changes

Caellion and others added 3 commits December 15, 2021 07:31

Update modules/templates/helper.go

3a0d6ef

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

partial suggested changes

46a2090

it actually is log.Warn

c37264d

wxiaoguang reviewed Dec 15, 2021

View reviewed changes

modules/templates/helper.go Outdated Show resolved Hide resolved

template.HTML(html.EscapeString(raw)) instead of `template.HTML(mar…

fda6ca3

…kup.Sanitize(raw))` in `Markdown2html`

Caellion and others added 2 commits December 17, 2021 15:11

Apply suggestions from code review

585dfe5

Co-authored-by: silverwind <me@silverwind.io>

Merge branch 'main' into main

671b457

Merge branch 'main' into main

1905d60

lunny added the type/enhancement An improvement of existing functionality label Dec 21, 2021

Caellion added 2 commits December 27, 2021 07:36

Merge branch 'main' into main

f98f234

Merge branch 'go-gitea:main' into main

b4eec88

Caellion force-pushed the main branch from f5f21eb to b4eec88 Compare February 2, 2022 07:24

Caellion and others added 2 commits February 2, 2022 08:25

Merge branch 'go-gitea:main' into main

47131ad

gofumpt

182d358

lunny reviewed Feb 2, 2022

View reviewed changes

Caellion added 2 commits February 24, 2022 12:55

Merge branch 'main' into main

450ed1a

Merge branch 'go-gitea:main' into main

5658b43

techknowlogick modified the milestones: 1.17.0, 1.18.0 Jun 8, 2022

lunny modified the milestones: 1.18.0, 1.19.0 Oct 17, 2022

lunny removed this from the 1.19.0 milestone Feb 1, 2023

wxiaoguang added the issue/needs-feedback For bugs, we need more details. For features, the feature must be described in more detail label Apr 24, 2023

wxiaoguang closed this May 1, 2023

go-gitea locked as resolved and limited conversation to collaborators Aug 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for markdown in checks description #17980

Adding support for markdown in checks description #17980

Caellion commented Dec 14, 2021 •

edited

Loading

codecov-commenter commented Dec 14, 2021 •

edited

Loading

lunny commented Dec 14, 2021

Caellion commented Dec 14, 2021

lunny commented Dec 15, 2021

zeripath commented Dec 17, 2021

Caellion commented Dec 17, 2021

lunny Feb 2, 2022

lunny Feb 2, 2022

wxiaoguang Feb 2, 2022

silverwind Feb 16, 2022

Caellion Feb 16, 2022

silverwind Feb 16, 2022 •

edited

Loading

techknowlogick commented Feb 16, 2022

wxiaoguang commented Mar 31, 2022 •

edited

Loading

lunny commented Jun 4, 2022

wxiaoguang commented Apr 24, 2023

lunny commented Apr 24, 2023

silverwind commented Apr 24, 2023

wxiaoguang commented May 1, 2023

Adding support for markdown in checks description #17980

Adding support for markdown in checks description #17980

Conversation

Caellion commented Dec 14, 2021 • edited Loading

codecov-commenter commented Dec 14, 2021 • edited Loading

Codecov Report

lunny commented Dec 14, 2021

Caellion commented Dec 14, 2021

lunny commented Dec 15, 2021

zeripath commented Dec 17, 2021

Caellion commented Dec 17, 2021

lunny Feb 2, 2022

Choose a reason for hiding this comment

lunny Feb 2, 2022

Choose a reason for hiding this comment

wxiaoguang Feb 2, 2022

Choose a reason for hiding this comment

silverwind Feb 16, 2022

Choose a reason for hiding this comment

Caellion Feb 16, 2022

Choose a reason for hiding this comment

silverwind Feb 16, 2022 • edited Loading

Choose a reason for hiding this comment

techknowlogick commented Feb 16, 2022

wxiaoguang commented Mar 31, 2022 • edited Loading

lunny commented Jun 4, 2022

wxiaoguang commented Apr 24, 2023

lunny commented Apr 24, 2023

silverwind commented Apr 24, 2023

wxiaoguang commented May 1, 2023

Caellion commented Dec 14, 2021 •

edited

Loading

codecov-commenter commented Dec 14, 2021 •

edited

Loading

silverwind Feb 16, 2022 •

edited

Loading

wxiaoguang commented Mar 31, 2022 •

edited

Loading