github-action-markdown-link-check icon indicating copy to clipboard operation
github-action-markdown-link-check copied to clipboard

Use a group, not manual formatting of results

Open michamos opened this issue 4 years ago • 4 comments
trafficstars

Uses the ::group workflow command to group the results instead of printing ASCII delimiters.

michamos avatar Aug 18 '21 14:08 michamos

Thank you @michamos for this PR.

I agree with you that it looks neat with groups. However, considering the usability, the change adds an extra click to view the results.

I might be opinionated, but I am happy to discuss how this improves existing output.

gaurav-nelson avatar Aug 19 '21 00:08 gaurav-nelson

For me the biggest issues in Github workflows output is having to scroll back to find the relevant content. I'd rather have a clear label and one extra click rather than a wall of text you need to precisely scroll into to find what you're looking for.

michamos avatar Aug 19 '21 07:08 michamos

@michamos What if:

  1. we can group the other output you see under groups and leave the actual output out of groups? That way the actual output would be accecible without any clicks and you won't see other fluff?
  2. or may be add a configuration option and leave it as a choice so users can enable groups in output if they want.

I like the first option. Or something else you want to add.

gaurav-nelson avatar Aug 19 '21 23:08 gaurav-nelson

Indeed, the first option sounds great :+1: I think it would be best if you make the changes and group things in a way that makes sense.

michamos avatar Aug 24 '21 09:08 michamos