place-labs / orthograph-err

Automated docs reviewer. Robotic grammar enthusiast.
MIT License
5 stars 3 forks source link

GH checks API annotation limit reached #1

Open wshirey opened 4 years ago

wshirey commented 4 years ago

For PR events, does this action only check affected files in the PR or all files in the defined path variable? I'm getting the following error which I assume is because I'm checking all markdown files in my repo instead of ones changed in the PR, and a Github API request to annotate those files is hitting a limit.

Invalid request.

No more than 50 items are allowed; 422 were supplied.
kimburgess commented 4 years ago

Hey there - I managed to miss this when first logged, apologies for the delayed response.

The current implementation checks all files matching the path input. This has a sensible default, but can be specified by an upstream action such as gh-action-get-changed-files too. This should let you set up a workflow that checks everything on master branch commits, then a filtered check only on PR’s if that better matches your needs.

There’s a seperate issue here where it does not currently page those annotations if it exceeds the 50 limit. That should definitely happen.

wshirey commented 4 years ago

Thanks for tip on the gh-action-get-changed-files. I'll look into that. And thanks for the open source work!

kimburgess commented 4 years ago

Any time. Glad it’s useful.

I’ll edit this issue title to reflect that annotation limit issue so that it’s not missed too.