Closed guillermocalvo closed 1 month ago
Hi @guillermocalvo,
I like the idea to create markdown reports, especially together with Github Actions it sounds to be an interesting enhancement.
I have just taken a first look at the implementation and it looks good.
Currently I am travelling and do not have the time to review everything in detail. But I will do a thorough review as soon as I find enough time for it.
Thanks in advance for this work.
Currently I am travelling and do not have the time to review everything in detail. But I will do a thorough review as soon as I find enough time for it.
@siom79 I know it's a big PR in terms of files changed. Please take your time and let me know if you'd like to change anything. Thanks for reviewing it!
together with Github Actions it sounds to be an interesting enhancement.
It would be a great fit for the job summary feature of GitHub Actions!
Solved by #405
Currently, japicmp supports generating reports in the following formats:
I propose adding a new option
--markdown
to generate reports in Markdown format. This format offers the structured benefits of HTML, while also being human-readable. It is particularly useful for job summaries in GitHub Actions. Additionally, Markdown reports can include for enhanced visual appeal.The CLI should generate reports in plain text unless
--markdown
is specified. The Maven plugin should produce reports in all supported formats, including Markdown, resulting in files with the.md
extension.