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

feature request: report results as a PR comment? #17

Closed
ooloth opened this issue Nov 24, 2019 · 5 comments
Closed

feature request: report results as a PR comment? #17

ooloth opened this issue Nov 24, 2019 · 5 comments

Comments

@ooloth
Copy link

ooloth commented Nov 24, 2019

Thanks for this project!

Would it be possible to see the results of each Lighthouse audit as a comment on the PR (similar to the behaviour of the deprecated lighthousebot project)?

@robinmetral
Copy link

FYI, the Typescript website repo has something like this set up using a Danger plugin, danger-plugin-lighthouse (by @orta).

It looks like this:

source: microsoft/TypeScript-Website#121
Screenshot_2019-11-25 Fill out the TS Config reference by orta · Pull Request #121 · microsoft TypeScript-Website

I agree that it would be nice to make this possible in this action without a Danger dep 🙂

@orta
Copy link
Contributor

orta commented Nov 25, 2019

Yeah, I think might be able to provide some text inside inside a GitHub check (Danger has this as a feature).

I found it a particularly weak use-case for anything which isn't an obvious hard pass/fail though because no one will click through to see the results if it's not blocking their way. Via an GH action you don't have enough auth to write a comment though, so it probably is the best option.

That said - if you do, I'd love to share ideas on the results JSON -> markdown rendering

@exterkamp
Copy link
Collaborator

That said - if you do, I'd love to share ideas on the results JSON -> markdown rendering

We have been playing with the idea of using the markdown results of the check as output here #2. But since this is an action it is a bit limited vs. a full app on what we can do in the action native status, we basically have to post a new status.

Via an GH action you don't have enough auth to write a comment though

We can get a client to do git stuff, like post statuses and I think comments with the octokit client via pulls.createComment

@paulirish
Copy link
Contributor

Please also see #2 (comment) where I summarized some of the options we have.

@alekseykulikov
Copy link
Member

From our experience, a comment for each PR provides more noise, than value. To track the history, it's better to use LHCI Server. If the tests fail, the action uses annotations #2 (comment)

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

No branches or pull requests

6 participants