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

redocly lint format html or markdown #1539

Open
marianobntz opened this issue Apr 24, 2024 · 5 comments
Open

redocly lint format html or markdown #1539

marianobntz opened this issue Apr 24, 2024 · 5 comments

Comments

@marianobntz
Copy link

Is your feature request related to a problem? Please describe.

I am using redocly to generate the lint report to see warnings in an azure devops pipeline. I would like to show the lint report inside the pipeline results but I am having trouble finding a way to do it.

Any current format (1.11.0) is not suitable to upload directly so I would need to transform the report to another format and then upload.

Describe the solution you'd like

A new format for lint for markdown or html would greatly help my task. Thanks,

Describe alternatives you've considered

I am evaluating which format is more suitable for transformation but I could not find anything useful yet. Doing json to html convertion would be really difficult.

Additional context

@tatomyr
Copy link
Contributor

tatomyr commented Apr 25, 2024

Hi @marianobntz! How would you expect the results to be formatted in the markdown format?
I'm not sure, but maybe using the stats command with the --format=markdown option could be a workaround for your case?

@marianobntz
Copy link
Author

Will try it but I need the actual warnings and errors just like the codeframe format. Will let you know soon.

Thanks

@marianobntz
Copy link
Author

Just FYI... I made a powershell script to parse the redocly codeframe output and show it in Azure Devops pipeline as warnings and errors in the pipeline run.

Not sure how to add it to the cookbook or not... but I can try if you think it is worth it 😄

@lornajane
Copy link
Collaborator

That's pretty cool. Did you see that we also added a markdown output format to the lint command? It's in #1559 - merged but not released yet.

@marianobntz
Copy link
Author

yes yes, saw the PR, it would have helped with my parsing 😃 but now I like having the errors and warnings in the pipeline ... that way my analysts can see the problems pretty easily...

I will take a look at the markdown output when it is released! THANKS!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants