krr
krr copied to clipboard
robusta-dev
Add support for markdown table output.
Is your feature request related to a problem? Please describe.
To publish the report as GitHub issues it would be great if the output can be formatted as a markdown table.
Describe the solution you'd like
Add a formatter that allows to format as a markdown table.
Describe alternatives you've considered
Doing all kind of jq magic or other transformations on the output.
Hi @marcofranssen, I love the idea. Do you plan to run this in GitHub actions? If so, can you elaborate?
Curious to learn more about the end to end flow here and solve it.
At the moment I just wanted to copy the results into a GitHub issue for us to work on some improvements. Running it in GH Action is a nice idea though.
Another idea that pops to mind is a feature that submits individual issues for components. Maybe even with some filtering based on threshold like, if the current value is off by more the x%, only then submit an issue on the GitHub repo. However I would consider that as a separate enhancement from just being able to format the output as a markdown table.
@marcofranssen we haven't been able to get to this ourselves yet! Would you be interested in opening a PR?
The relevant code is here - https://github.com/robusta-dev/krr/tree/main/robusta_krr/formatters
You just need to add a custom markdown table formatter.