cspell-action icon indicating copy to clipboard operation
cspell-action copied to clipboard

Include problem matcher so issues are highlighted in PRs

Open nschonni opened this issue 5 years ago • 4 comments

EX: https://github.com/xt0rted/markdownlint-problem-matcher/blob/master/.github/problem-matcher.json The matcher needs to be registered as part of the action rather than manually added to repos registered like https://github.com/dotnet/docs/blob/c3a769228cb87c7394a5baaffc7a28f6d1fc24bd/.github/workflows/markdownlint.yml#L30

Here are the registration lines from that repo from the API instead of the commandline https://github.com/xt0rted/markdownlint-problem-matcher/blob/31939ffafb5b423ffafae13bd3aad77d36481133/src/main.ts#L19-L25

nschonni avatar Aug 10 '20 02:08 nschonni

@nschonni this action will annotate the pull-request.

Jason3S avatar Dec 17 '20 15:12 Jason3S

Sorry, are you saying it should be doing this now, or will in the future?

nschonni avatar Dec 17 '20 18:12 nschonni

This github action (cspell-action) now works. It will report errors in pull-requests and mark the files with warnings.

There are some more options that need to be implimented:

  1. specify the path to the config file
  2. specify a list files
  3. option to fail the build if spelling errors are found
  4. output a summary of the results.

Jason3S avatar Dec 17 '20 19:12 Jason3S

~I tried this action and there are not review comments for problematic lines :-( Was that supposed to work already or is that not yet implemented (can't quite get it from the last comment: what does "report errors in pull-requests" mean)?~

Now the review comments showed up -> PR comments for typos work!

jankatins avatar Aug 22 '22 14:08 jankatins