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@edccef0)
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)
- dropping commenting on pushes (people should migrate to github step summaries)

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"

.github/workflows/spelling3.yml

JohnMcPMS

Cannot allow write permissions.

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.

mominshaikhdevs · 2024-07-11T14:41:56Z

what's the latest update on this?

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

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

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

jsoref · 2024-07-12T03:58:03Z

.github/actions/spelling/advice.md

@@ -23,3 +25,6 @@ https://www.regexplanet.com/advanced/perl/) yours before committing to verify it
  Note that patterns can't match multiline strings.

 </details>
+<!--
+template: check-spelling


per #3896 (comment)

@denelon I hope this meets your needs, but you're welcome to change it to some other pattern.

jsoref · 2024-07-12T04:01:45Z

src/WinGetUtilInterop.UnitTests/TestCollateral/AllEquality.yaml

@@ -21,7 +21,7 @@ Installers:
      Language: /en-US
      Custom: /s
  - Arch: x64
-    Url: https://contosa.net/publiccontainer/contosainstaller64.exe
+    Url: https://contoso.com/publiccontainer/contosoinstaller64.exe


I think I'd been ignoring this for a while... contoso.com is microsoft's domain. contosa is a typo of contoso, and contosa.net isn't registered.

If this needs to not be contoso.com, it should be an example.com or some other microsoft controlled domain...

jsoref · 2024-07-16T21:39:28Z

Hmm.. I guess I need to rebase -- I was hoping @denelon or @JohnMcPMS would have reviewed it since...

At this point, I'm close to releasing the next version...

denelon · 2024-07-16T23:15:18Z

Sorry about that! We've been super busy with some internal work and haven't been as good as we should have been about reviewing external PRs. Do you want me to get someone to review this or hold off until the next release?

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

jsoref · 2024-07-17T15:53:36Z

.github/workflows/spelling3.yml

-  comment-push:
-    name: Report (Push)
-    # If your workflow isn't running on push, you can remove this job
-    runs-on: ubuntu-latest
-    needs: spelling
-    permissions:
-      contents: write


I'm removing this job from the flow.

In the long term, I'm nudging people to rely on the step summary (which happens automatically) over adding comments, but in the near term, people can rely on comments when they make a pull request.

JohnMcPMS · 2024-07-24T17:12:31Z

/azp run

azure-pipelines · 2024-07-24T17:12:42Z

Azure Pipelines successfully started running 1 pipeline(s).

JohnMcPMS · 2024-07-29T17:47:05Z

/azp run

azure-pipelines · 2024-07-29T17:47:16Z

Azure Pipelines successfully started running 1 pipeline(s).

jsoref · 2024-07-31T11:24:49Z

@JohnMcPMS could you add check-spelling/actions-checkout@* to the exemptions list? It isn't used at this time, but because of the logic, the runtime doesn't know.

Check Spelling
Bad request - check-spelling/actions-checkout@v4 is not allowed to be used in microsoft/winget-cli. Actions in this workflow must be: within a repository that belongs to your Enterprise account, created by GitHub, or matching the following: check-spelling/check-spelling@*, check-spelling/checkout-merge@*, craigloewen-msft/gitgudsimilarissues@*.

denelon · 2024-07-31T15:14:32Z

@jsoref, I just added it.

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 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

jsoref added 2 commits July 11, 2024 15:07

spelling: anymore

a83c166

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

spelling: cannot

460fb6b

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

jsoref force-pushed the check-spelling-v0.0.22 branch 2 times, most recently from 6236f70 to 051f9ba Compare July 12, 2024 03:57

jsoref added 10 commits July 11, 2024 23:59

spelling: case-insensitive

254b113

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

spelling: case-sensitive

2e15172

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

spelling: check in

30f35ca

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

spelling: contoso.com

64f27e7

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

spelling: dependent

75a2886

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

spelling: fine-grained

6fa4edd

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

spelling: information

de2432c

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

spelling: its

7092772

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

spelling: other

19477de

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

spelling: prepopulate

f2c0751

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

jsoref added 5 commits July 12, 2024 00:00

spelling: regex

ff815e8

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

spelling: statically

3b49f0a

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

spelling: this

d65fece

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

spelling: unknown

9bde502

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

spelling: version

8f5a7f6

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

jsoref force-pushed the check-spelling-v0.0.22 branch from 051f9ba to 7a6055b Compare July 12, 2024 04:00

jsoref commented Jul 12, 2024

View reviewed changes

jsoref force-pushed the check-spelling-v0.0.22 branch from 7a6055b to 8a51af7 Compare July 17, 2024 15:17

Upgrade check-spelling to v0.0.22

d92289f

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

jsoref force-pushed the check-spelling-v0.0.22 branch from 8a51af7 to d92289f Compare July 17, 2024 15:31

jsoref commented Jul 17, 2024

View reviewed changes

florelis approved these changes Jul 17, 2024

View reviewed changes

JohnMcPMS approved these changes Jul 24, 2024

View reviewed changes

JohnMcPMS merged commit 6df6ded into microsoft:master Jul 30, 2024
8 checks passed

microsoft-github-policy-service bot removed the Needs-Attention Issue needs attention from Microsoft label Jul 30, 2024

jsoref deleted the check-spelling-v0.0.22 branch July 31, 2024 11: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

Loading

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

JohnMcPMS left a comment

denelon commented Jan 6, 2024

jsoref commented Jan 6, 2024

mominshaikhdevs commented Jul 11, 2024

jsoref Jul 12, 2024

jsoref Jul 12, 2024

jsoref Jul 12, 2024

jsoref commented Jul 16, 2024

denelon commented Jul 16, 2024

jsoref Jul 17, 2024

JohnMcPMS commented Jul 24, 2024

azure-pipelines bot commented Jul 24, 2024

JohnMcPMS commented Jul 29, 2024

azure-pipelines bot commented Jul 29, 2024

jsoref commented Jul 31, 2024

denelon commented Jul 31, 2024

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

Upgrade to check-spelling v0.0.22 #3896

Upgrade to check-spelling v0.0.22 #3896

Conversation

jsoref commented Nov 15, 2023 • edited Loading

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

JohnMcPMS left a comment

Choose a reason for hiding this comment

denelon commented Jan 6, 2024

jsoref commented Jan 6, 2024

mominshaikhdevs commented Jul 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref commented Jul 16, 2024

denelon commented Jul 16, 2024

Choose a reason for hiding this comment

JohnMcPMS commented Jul 24, 2024

azure-pipelines bot commented Jul 24, 2024

JohnMcPMS commented Jul 29, 2024

azure-pipelines bot commented Jul 29, 2024

jsoref commented Jul 31, 2024

denelon commented Jul 31, 2024

jsoref commented Nov 15, 2023 •

edited

Loading