ataylorme / eslint-annotate-action

A GitHub action that takes ESLint results from a JSON file and adds them as annotated pull request comments
MIT License
88 stars 32 forks source link

Add option to show markdown report on step summary #54

Closed KrijnL closed 1 year ago

KrijnL commented 1 year ago

The motivation for creating this PR is that the code generates a really nice Markdown summary and then never uses it. This conflicts with what is mentioned in the README, but I assume that's due to changes that happened in v2.

In any case it can be nice to show the report on pull requests, so that you get to see the errors that are not in your PR as well. Can also be useful on pulls if there were commits directly on a branch, without going through PR steps (ideally that should never happen, of course, but I've seen enough cases where it does...)

PS. I ran a npm run build, but if there are any other steps I need to take to build the action, please let me know!

KrijnL commented 1 year ago

Hi Andrew,

Thanks for taking a look at my PR and merging the other ones so quickly! Your requested change makes total sense. I've synced my forked repo with yours, rebased the branch and implemented the change you requested.

I'm not entirely sure why the merge check is failing. If there is anything I need to change, do let me know!

Warm regards

ataylorme commented 1 year ago

@KrijnL the tests is failing due to security reasons GITHUB_TOKEN has only read access from fork PRs and needs write to run the Action.

I will test it locally and then, if things look good, merge this in.