Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to generate Markdown report #6538

Closed
dgutson opened this issue Feb 22, 2023 · 5 comments
Closed

Ability to generate Markdown report #6538

dgutson opened this issue Feb 22, 2023 · 5 comments
Labels
enhancement Issues that are considered to be enhancements reporter About the reporter tool

Comments

@dgutson
Copy link

dgutson commented Feb 22, 2023

..so report can be added to a github/gitlab repository (eg README.md and/or set of files).

I know that Asciidoctor output could be converted to markdown with pandoc, but I'm not sure the conversion is optimal. I think it's worth to add a native reporter.

@sschuberth
Copy link
Member

sschuberth commented Feb 22, 2023

Actually, the existing NoticeTemplateReporter should already be capable of doing this: All it does it to take a "templatized" plain text file (which defaults to default.ftl), runs FreeMarker on it to expand the templates, and writes out that file again.

So, if you'd create a custom template that's actually Markdown (plus FreeMarker templates to loop over packages etc.) and specify that via the reporter-specific template.path option, you should get a plain Markdown file in the end.

@sschuberth sschuberth added enhancement Issues that are considered to be enhancements reporter About the reporter tool labels Feb 22, 2023
@dgutson
Copy link
Author

dgutson commented Feb 22, 2023

@Franco0700 please check this out and contribute the markdown template

@tsteenbe
Copy link
Member

tsteenbe commented Feb 22, 2023

Ping @fviernau as we were discussing a MarkDown-based summary ORT result report for the GitHub action for ORT

@fviernau
Copy link
Member

FYI: I'm just starting working on a report which can create a short summary of a CI run, e.g. for use with a GitHub action, which would include some template.

@mnonnenmacher
Copy link
Member

The NoticeTemplateReporter was renamed to PlainTextTemplateReporter in #6584. This is the recommend way to generate Markdown reports.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issues that are considered to be enhancements reporter About the reporter tool
Projects
None yet
Development

No branches or pull requests

5 participants