search

crate-ci / typos

Source code spell checker
Apache License 2.0
2.31k stars 92 forks source link

Support to post comments to a pull request in the GitHub Action #1036

Open yu-iskw opened 3 weeks ago

yu-iskw commented 3 weeks ago

Overview

GitHub allows us to post comments with suggestions to a pull request. As far as I am concerned, the current implementation of the GitHub Action scans all files no matter what file we change. It would be great to post comments with suggestions only to changed files using the Action.

https://docs.github.com/en/rest/pulls/comments?apiVersion=2022-11-28#create-a-review-comment-for-a-pull-request

Expected behavior

We can configure the mode to scan all files or to post comments with suggestions in the Action. By doing so, we can improve typos more easily.

epage commented 3 weeks ago

There are two parts to this that I want to better understand their relationship

Why do you see those as related?

Also, like #778, we should have reporting and we have an idea for improving reporting with sarif.