Added new reporter: MARKDOWN_SUMMARY Reporter

[saishivarcr]

New reporter MARKDOWN_SUMMARY_REPORTER, allows saving MegaLinter results summary as a markdown file. This file can be further utilised to add comments on the pull request (PR) from Jenkins and other continuous integration (CI) tools.

[echoix]

Do you use or intend to use it with Jenkins? I think you could expand on the use cases in your documentation for better discovery.

I see another useful use-case with this: something that implements #1489

I once tried to start it, but only finished the research phase.
https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

The only missing change to enable this functionality would be to check if the GITHUB_STEP_SUMMARY env var exists, and if so, save the Markdown file there.

[nvuillam]

@saishivarcr thanks a lot for your PR :)

we already have reporters for Github, Gitlab & Azure (and probably bitbucket someday) -> https://megalinter.io/latest/reporters/

If it is for jenkins purpose, why not some JENKINS_COMMENT_REPORTER, that would handle the overwrite on existing comment etc... like the other CI platforms reporters ? ( or even a standalone Jenkins Plugin ? 👼 )

Otherwise, I'm ok to merge your PR, but with the following pre-requisites:

• rename it as MARKDOWN_SUMMARY_REPORTER
• deactivate it by default, except if you find a way to post it by default as Job Summary like suggested by @echoix :)

[saishivarcr]

Thanks @echoix for providing your feedback.

Do you use or intend to use it with Jenkins? I think you could expand on the use cases in your documentation for better discovery.

Yes, my primary use case is to post the job summary as a PR comment from the Jenkins pipeline job. Once the summary report is available in markdown format, one can write a custom script to post it to Bitbucket or other repository hosting platforms (non-Github/Gitlab) without waiting for such functionality to be made officially available.

I see another useful use-case with this: something that implements #1489

I once tried to start it, but only finished the research phase. https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/ https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

The only missing change to enable this functionality would be to check if the GITHUB_STEP_SUMMARY env var exists, and if so, save the Markdown file there.

Yes, this use case can now be covered easily with minimal enhancements. I will work on this in a separate PR.

[saishivarcr]

Thanks @nvuillam for your feedback.

If it is for jenkins purpose, why not some JENKINS_COMMENT_REPORTER, that would handle the overwrite on existing comment etc... like the other CI platforms reporters ? ( or even a standalone Jenkins Plugin ? 👼 )

I wanted to make it generic and not tied to either Jenkins or other CI platforms. The Jenkins plugin is a great idea, but I don't have much experience in developing one. This can be considered for further enhancements in upcoming versions.

• rename it as MARKDOWN_SUMMARY_REPORTER

Yes, this is a good suggestion; I will make this change.

• deactivate it by default, except if you find a way to post it by default as Job Summary like suggested by @echoix :)

By default, this feature is deactivated. Could you kindly verify this once again through a code review on your end?

[nvuillam]

@saishivarcr I already checked your code and it seems right to me, so once the renaming done, I'll merge then it'll be shipped in the next release 🥳 🎈

[nvuillam]

Great, many thanks :)
Plz check comments for tiny updates :)

[nvuillam]

Great :)