Use check-spelling/check-spelling@v0.0.20#9111
Conversation
| outputs: | ||
| followup: ${{ steps.spelling.outputs.followup }} | ||
| runs-on: ubuntu-latest | ||
| if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'" |
There was a problem hiding this comment.
Isn't this redundant since the top-level on key basically does the same..?
There was a problem hiding this comment.
Yes. This workflow is a subset of a version of the workflow which includes a comment handler.
It's fairly harmless to retain, but if you like, it can be dropped.
| id: spelling | ||
| uses: check-spelling/check-spelling@v0.0.20 | ||
| with: | ||
| suppress_push_for_open_pull_request: 1 |
There was a problem hiding this comment.
These new lines need inline comments for future visitors.
.github/workflows/spelling.yml
Outdated
| needs: spelling | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write |
There was a problem hiding this comment.
Can we do away with PR comments? I think inline comments (check-run annotations) are more than sufficient.
There was a problem hiding this comment.
You only get 10 of each type (error, warning, notice) per job.
If you're ok with that constraint, then, yes.
Also note that if the lines that would be commented aren't changed in the PR (because they snuck into the base), then they usually won't be annotated. (GitHub occasionally shows such things, probably based on A/B testing or similar.)
There was a problem hiding this comment.
Yes. 10 GitHub Annotations is sufficient. You may disable posting PR comments.
| outputs: | ||
| followup: ${{ steps.spelling.outputs.followup }} | ||
| runs-on: ubuntu-latest | ||
| if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'" |
There was a problem hiding this comment.
Yes. This workflow is a subset of a version of the workflow which includes a comment handler.
It's fairly harmless to retain, but if you like, it can be dropped.
.github/workflows/spelling.yml
Outdated
| needs: spelling | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write |
There was a problem hiding this comment.
You only get 10 of each type (error, warning, notice) per job.
If you're ok with that constraint, then, yes.
Also note that if the lines that would be commented aren't changed in the PR (because they snuck into the base), then they usually won't be annotated. (GitHub occasionally shows such things, probably based on A/B testing or similar.)
Refreshes the workflow based on https://github.com/check-spelling/spell-check-this/blob/744c66e2140fd8acaf5388efd0db3727d010d6e9/.github/workflows/spelling.yml Changing the workflow not to post a comment, reporting is presented via annotations.
|
Thanks @jsoref |
Josh Soref: Use check-spelling/check-spelling@v0.0.20 (#9111) Merge pull request 9111
This is a 🐛 bug fix.
Summary
https://github.com/check-spelling/spell-check-this/blob/744c66e2140fd8acaf5388efd0db3727d010d6e9/.github/workflows/spelling.yml
Context
Closes #9091