search

foo-software / lighthouse-check-action

GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more!
https://github.com/marketplace/actions/lighthouse-check
MIT License
480 stars 24 forks source link

Add a way to write the PR comments in a compact manner using a markdown table #123

Open SeeringPhil opened 1 year ago

SeeringPhil commented 1 year ago

Is your feature request related to a problem? Please describe. When running on multiple urls (in my case, a baseUrl with subPaths), the format is not as expected when displaying performance. See issue https://github.com/foo-software/lighthouse-check-action/issues/122

I think adding a way to display the results in a more compact manner, like the solution described below, would both provide a nice solution to my personal problem while adding a valuable new feature to everyone using the action.

Right now, the way the results are displayed quickly becomes noisy and clutters the PR, while having this possibility would improve the readability.

Describe the solution you'd like Provide a mechanism to have a compact comment mode which would output something like this:

Device URL Accessibility Best practices Performance PWA SEO
mobile baseUrl 95 90 95 80 100
desktop baseUrl 90 90 95 80 100
mobile baseUrl/subPath1 92 90 95 80 100
desktop baseUrl/subPath1 92 90 95 80 100

Additional context N/A

SeeringPhil commented 1 year ago

A suggestion for the possible input parameter could be : 'prCommentCompact' or maybe 'prCommentTable'

stale[bot] commented 11 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

SeeringPhil commented 5 months ago

@adamhenson Thanks for the feedback!

Knowing you accept PRs I'll take a look at implementing the changes I mentioned in those 2 issues when I'll get around to implement lighthouse checks in our projects.

adamhenson commented 5 months ago

Thanks @SeeringPhil - and FWIW this GitHub Action is pretty much a pass-through to @foo-software/lighthouse-check (which I also maintain), which is where the change would really need to happen.