errata-ai / vale-action

:octocat: The official GitHub Action for Vale -- install, manage, and run Vale with ease.
MIT License
195 stars 46 forks source link

Unable to create annotations; printing Vale alerts instead for PRs #12

Open mattbrailsford opened 4 years ago

mattbrailsford commented 4 years ago

I'm using Vale on my documentation repository at https://github.com/vendrhub/vendr-documentation/ and all seems to work fine when I make commits to the core repository myself, however, for people submitting PR's it appears that Vale fails to create annotations and instead just prints the errors out to the console instead.

https://github.com/vendrhub/vendr-documentation/pull/14/checks?check_run_id=632785607

Is there something amiss in my config as to why this is the case?

/Matt

jdkato commented 4 years ago

See https://github.com/errata-ai/vale-action#limitations.

I believe Problem Matchers are the correct way to handle this now, though (which weren't documented yet when I wrote this action).

jnikhila commented 1 year ago

Hey there! The readme on the repo suggests using errata-ai/vale-action@reviewdog for linitng. If I change it to errata-ai/vale-action@master instead of errata-ai/vale-action@reviewdog then I start getting the below error:

Annotations
1 warning
Unable to create annotations; printing Vale alerts instead.

Should the master be discarded for linting? Please confirm.

To add more to the above. If I don't use master - the properties onlyAnnotateModifiedLines and __onlyModified are considered invalid.

jdkato commented 1 year ago

The two branches are different versions that have different features. I recommend using the reviewdog branch so that you can Vale CLI updates, but the other can still be used.

gene1wood commented 1 year ago

Here's a fixed link to the historical "Limitations" section of the readme that @jdkato mentions above

https://github.com/errata-ai/vale-action/blob/v1.2.0/README.md#limitations