Upgrade to check-spelling v0.0.22 #3896

jsoref · 2023-11-15T17:27:44Z

I have signed the Contributor License Agreement.
This pull request is related to Add suggested dictionaries for spellchecking and remove unneeded words #3885 (comment)

Changes:

general spelling/grammar
refreshed baseline metadata (roughly spell-check-this@82d4530)
upgraded to check-spelling v0.0.22
- ⚠️ there's one pattern that triggers in v0.0.21 (as part of this PR) which will not trigger once this PR is merged (🩹 Pattern suggestions shouldn't trip over active patterns)
refreshed workflow
- slightly refreshed dictionaries -- I'm removing cspell:cpp/src/cpp.txt, but you could use it or cspell:cpp/dict/cpp.txt -- I think I missed that Add suggested dictionaries for spellchecking and remove unneeded words #3885 was adding it -- cpp suffers from the same problem as win32 -- too many misspelled words)
enabling sarif output (when possible) -- this is, of course, optional, enabling it requires granting an additional permission, but as this is the only action for the repository, that shouldn't be a problem -- the output is a lot shinier thanks to github's sarif handling than the older output mode
enabling talking to the workflow (when in a PR but not to this repository) -- this lets users in their own forks ask the workflow to update the expect file for them instead of requiring them to run commands on their local computer

Microsoft Reviewers: Open in CodeFlow

jsoref · 2023-11-15T17:28:40Z

.github/actions/spelling/excludes.txt

-# Because it doesn't handle argument -Words well
-^tools/CorrelationTestbed/.*\.ps1$
-^tools/COMTrace/ComTrace.wprp$


afaict this is no longer a problem, so I'm dropping it

jsoref · 2023-11-15T17:29:51Z

.github/actions/spelling/expect.txt

-TOperation
-TOptions
-TProgress
-TResult
-TReturn
 trimstart
-TState
-TStatus


These T[A-Z] items are handled by a pattern below.

.github/actions/spelling/patterns.txt

.github/workflows/spelling3.yml

jsoref · 2023-11-15T17:31:45Z

.github/workflows/spelling3.yml

-    if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
+    if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}


this is purely stylistic -- the vscode github integration doesn't like "..." whereas GitHub Actions do not mind.

.github/workflows/spelling3.yml

jsoref · 2023-11-15T17:38:40Z

.github/workflows/spelling3.yml

        extra_dictionaries:
-          cspell:cpp/src/compiler-msvc.txt
-          cspell:cpp/src/cpp.txt


this dictionary is lousy (way too many typos included, similar to the win32 dictionary) -- as of v0.0.22, I 🗑️ Removed (both) Dictionaries from the suggestion list due to their poor quality.

I did look into trying to fix them, but they had so many typos that I ran out of energy trying to go over them.

I can see why you wouldn't want to suggest the lousy dictionaries, but I'm not totally convinced it is better for us to not use them. I'm not too invested in that position, though.

The downside I see to using them is that if we happen to make the same typo, we wouldn't notice. To me that seems somewhat unlikely, and if it does happen doesn't seem like that big of a deal. I assume the dictionary would get better over time, so those typos would eventually come up.
As for upsides, it will be easier for us to manage the lists of allow/expect if we have to add less words. If we have to add lots of words, I think it's more likely we're going to make another mistake like with "uknown"

.github/workflows/spelling3.yml

jsoref · 2023-11-15T17:39:50Z

.github/workflows/spelling3.yml

+        experimental_apply_changes_via_bot: ${{ github.repository_owner != 'microsoft' && 1 }}
+
+  update:
+    name: Update PR
+    permissions:
+      contents: write
+      pull-requests: write
+      actions: read
+    runs-on: ubuntu-latest
+    if: ${{
+        github.repository_owner != 'microsoft' &&
+        github.event_name == 'issue_comment' &&
+        github.event.issue.pull_request &&
+        contains(github.event.comment.body, '@check-spelling-bot apply')
+      }}
+    concurrency:
+      group: spelling-update-${{ github.event.issue.number }}
+      cancel-in-progress: false
+    steps:
+    - name: apply spelling updates
+      uses: check-spelling/check-spelling@v0.0.22
+      with:
+        experimental_apply_changes_via_bot: 1
+        checkout: true
+        ssh_key: "${{ secrets.CHECK_SPELLING }}"


This is, as noted, very optional, but it should make it easier for others to interact with the workflow instead of having to run programs on their own computer.

.github/actions/spelling/candidate.patterns

.github/actions/spelling/excludes.txt

.github/actions/spelling/patterns.txt

.github/actions/spelling/expect.txt

florelis · 2023-11-15T20:44:59Z

.github/workflows/spelling3.yml

        extra_dictionaries:
-          cspell:cpp/src/compiler-msvc.txt
-          cspell:cpp/src/cpp.txt


I can see why you wouldn't want to suggest the lousy dictionaries, but I'm not totally convinced it is better for us to not use them. I'm not too invested in that position, though.

The downside I see to using them is that if we happen to make the same typo, we wouldn't notice. To me that seems somewhat unlikely, and if it does happen doesn't seem like that big of a deal. I assume the dictionary would get better over time, so those typos would eventually come up.
As for upsides, it will be easier for us to manage the lists of allow/expect if we have to add less words. If we have to add lots of words, I think it's more likely we're going to make another mistake like with "uknown"

florelis · 2023-11-15T20:46:27Z

.github/workflows/spelling3.yml

+  issue_comment:
+    types:
+    - 'created'


What does this do? Check spelling when someone creates an issue?

When someone comments on an issue/PR it will trigger the workflow. Each job independently decides whether to do anything.

For,

winget-cli/.github/workflows/spelling3.yml

Line 80 in 64d4149

spelling:

It'll do nothing:

winget-cli/.github/workflows/spelling3.yml

Line 90 in 64d4149

if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}

For,

winget-cli/.github/workflows/spelling3.yml

Line 121 in 64d4149

comment-push:

It'll do nothing:

winget-cli/.github/workflows/spelling3.yml

Line 128 in 64d4149

if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push'

For,

winget-cli/.github/workflows/spelling3.yml

Line 136 in 64d4149

comment-pr:

It'll do nothing:

winget-cli/.github/workflows/spelling3.yml

Line 144 in 64d4149

if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')

It will only do work here:

winget-cli/.github/workflows/spelling3.yml

Lines 153 to 165 in 64d4149

update:

name: Update PR

permissions:

contents: write

pull-requests: write

actions: read

runs-on: ubuntu-latest

if: ${{

github.repository_owner != 'microsoft' &&

github.event_name == 'issue_comment' &&

github.event.issue.pull_request &&

contains(github.event.comment.body, '@check-spelling-bot apply')

}}

One of the criteria being that it isn't this repository.

If someone creates a PR within a single fork and it triggers a comment w/ a note about items that should be added to expect, the comment will include something like this from @check-spelling-bot:

JohnMcPMS

Cannot allow write permissions.

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

denelon · 2024-01-06T03:39:18Z

We use a "template: foo/bar/baz" type of convention for messages from bots so it's easy to build e-mail rules to filter those out. How hard would it be to add something like that to the spellcheck messages in PRs?

jsoref · 2024-01-06T23:31:02Z

@denelon, add a line to https://github.com/microsoft/winget-cli/blob/master/.github/actions/spelling/advice.md

You could even add it of the form:

<!--
template: check-spelling
-->

So that it's only seen by mail filters and not by humans.

jsoref requested a review from a team as a code owner November 15, 2023 17:27

jsoref commented Nov 15, 2023

View reviewed changes

jsoref force-pushed the check-spelling-v0.0.22 branch from 0a4ca44 to 64d4149 Compare November 15, 2023 17:42

florelis previously approved these changes Nov 15, 2023

View reviewed changes

jsoref dismissed florelis’s stale review via c1fe3a1 November 15, 2023 21:22

jsoref force-pushed the check-spelling-v0.0.22 branch from 64d4149 to c1fe3a1 Compare November 15, 2023 21:22

JohnMcPMS requested changes Dec 12, 2023

View reviewed changes

microsoft-github-policy-service bot assigned jsoref Dec 12, 2023

microsoft-github-policy-service bot added Needs-Author-Feedback Issue needs attention from issue or PR author Needs-Attention Issue needs attention from Microsoft and removed Needs-Author-Feedback Issue needs attention from issue or PR author labels Dec 12, 2023

jsoref added 9 commits December 12, 2023 16:35

spelling: cannot

c756361

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-insensitive

5ef74a3

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-sensitive

52c499f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: dependent

073a49d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: fine-grained

0889969

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: regex

25408a1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unknown

840acdc

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

Upgrade check-spelling to v0.0.22

9a1a9dc

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

Enable talk to the bot

d776ec2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref force-pushed the check-spelling-v0.0.22 branch from c1fe3a1 to d776ec2 Compare December 13, 2023 04:30

jsoref requested a review from JohnMcPMS December 13, 2023 06:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade to check-spelling v0.0.22 #3896

Upgrade to check-spelling v0.0.22 #3896

jsoref commented Nov 15, 2023 •

edited by microsoft-github-policy-service bot

jsoref Nov 15, 2023

jsoref Nov 15, 2023

jsoref Nov 15, 2023

jsoref Nov 15, 2023

florelis Nov 15, 2023

jsoref Nov 15, 2023

florelis Nov 15, 2023

florelis Nov 15, 2023

jsoref Nov 15, 2023

JohnMcPMS left a comment

denelon commented Jan 6, 2024

jsoref commented Jan 6, 2024

		if: "contains(github.event_name, 'pull_request') \|\| github.event_name == 'push'"
		if: ${{ contains(github.event_name, 'pull_request') \|\| github.event_name == 'push' }}

	update:
	name: Update PR
	permissions:
	contents: write
	pull-requests: write
	actions: read
	runs-on: ubuntu-latest
	if: ${{
	github.repository_owner != 'microsoft' &&
	github.event_name == 'issue_comment' &&
	github.event.issue.pull_request &&
	contains(github.event.comment.body, '@check-spelling-bot apply')
	}}

Upgrade to check-spelling v0.0.22 #3896

Are you sure you want to change the base?

Upgrade to check-spelling v0.0.22 #3896

Conversation

jsoref commented Nov 15, 2023 • edited by microsoft-github-policy-service bot

Microsoft Reviewers: Open in CodeFlow

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JohnMcPMS left a comment

Choose a reason for hiding this comment

denelon commented Jan 6, 2024

jsoref commented Jan 6, 2024

jsoref commented Nov 15, 2023 •

edited by microsoft-github-policy-service bot