mirror of
https://github.com/microsoft/PowerToys.git
synced 2025-12-16 03:37:59 +01:00
74a1a6eca2
This upgrades to [v0.0.24](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.24). A number of GitHub APIs are being turned off shortly, so you need to upgrade or various uncertain outcomes will occur. There's a new accessibility forbidden pattern: > Do not use `(click) here` links > For more information, see: > * https://www.w3.org/QA/Tips/noClickHere > * https://webaim.org/techniques/hypertext/link_text > * https://granicus.com/blog/why-click-here-links-are-bad/ > * https://heyoka.medium.com/dont-use-click-here-f32f445d1021 ```pl (?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\() ``` There are some minor bugs that I'm aware of and which I've fixed since this release, but I don't expect to make another release this month. I've added a pair of patterns for includes and pragmas. My argument is that the **compiler** will _generally_ tell you if you've misspelled an include and the **linker** will _generally_ tell you if you misspell a lib. - There's a caveat here: If your include case-insensitively matches the referenced file (but doesn't properly match it), then unless you either use a case-sensitive file system (as opposed to case-preserving) or beg clang to warn, you won't notice when you make this specific mistake -- this matters in that a couple of Windows headers (e.g. Unknwn.h) have particular case and repositories don't tend to consistently/properly write them.
210 lines
7.7 KiB
YAML
210 lines
7.7 KiB
YAML
# spelling.yml is blocked per https://github.com/check-spelling/check-spelling/security/advisories/GHSA-g86g-chm8-7r2p
|
|
name: Spell checking
|
|
|
|
# Comment management is handled through a secondary job, for details see:
|
|
# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
|
|
#
|
|
# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
|
|
# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
|
|
# it needs `contents: write` in order to add a comment.
|
|
#
|
|
# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
|
|
# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
|
|
# it needs `pull-requests: write` in order to manipulate those comments.
|
|
|
|
# Updating pull request branches is managed via comment handling.
|
|
# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
|
|
#
|
|
# These elements work together to make it happen:
|
|
#
|
|
# `on.issue_comment`
|
|
# This event listens to comments by users asking to update the metadata.
|
|
#
|
|
# `jobs.update`
|
|
# This job runs in response to an issue_comment and will push a new commit
|
|
# to update the spelling metadata.
|
|
#
|
|
# `with.experimental_apply_changes_via_bot`
|
|
# Tells the action to support and generate messages that enable it
|
|
# to make a commit to update the spelling metadata.
|
|
#
|
|
# `with.ssh_key`
|
|
# In order to trigger workflows when the commit is made, you can provide a
|
|
# secret (typically, a write-enabled github deploy key).
|
|
#
|
|
# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
|
|
|
|
# SARIF reporting
|
|
#
|
|
# Access to SARIF reports is generally restricted (by GitHub) to members of the repository.
|
|
#
|
|
# Requires enabling `security-events: write`
|
|
# and configuring the action with `use_sarif: 1`
|
|
#
|
|
# For information on the feature, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-SARIF-output
|
|
|
|
# Minimal workflow structure:
|
|
#
|
|
# on:
|
|
# push:
|
|
# ...
|
|
# pull_request_target:
|
|
# ...
|
|
# jobs:
|
|
# # you only want the spelling job, all others should be omitted
|
|
# spelling:
|
|
# # remove `security-events: write` and `use_sarif: 1`
|
|
# # remove `experimental_apply_changes_via_bot: 1`
|
|
# ... otherwise adjust the `with:` as you wish
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- "**"
|
|
tags-ignore:
|
|
- "**"
|
|
pull_request_target:
|
|
branches:
|
|
- "**"
|
|
types:
|
|
- "opened"
|
|
- "reopened"
|
|
- "synchronize"
|
|
issue_comment:
|
|
types:
|
|
- "created"
|
|
|
|
jobs:
|
|
spelling:
|
|
name: Check Spelling
|
|
permissions:
|
|
contents: read
|
|
pull-requests: read
|
|
actions: read
|
|
security-events: write
|
|
outputs:
|
|
followup: ${{ steps.spelling.outputs.followup }}
|
|
runs-on: ubuntu-latest
|
|
if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}
|
|
concurrency:
|
|
group: spelling-${{ github.event.pull_request.number || github.ref }}
|
|
# note: If you use only_check_changed_files, you do not want cancel-in-progress
|
|
cancel-in-progress: true
|
|
steps:
|
|
- name: check-spelling
|
|
id: spelling
|
|
uses: check-spelling/check-spelling@v0.0.24
|
|
with:
|
|
config: .github/actions/spell-check
|
|
suppress_push_for_open_pull_request: ${{ github.actor != 'dependabot[bot]' && 1 }}
|
|
checkout: true
|
|
check_file_names: 1
|
|
spell_check_this: microsoft/PowerToys@main
|
|
post_comment: 0
|
|
use_magic_file: 1
|
|
report-timing: 1
|
|
warnings: bad-regex,binary-file,deprecated-feature,ignored-expect-variant,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check,unclosed-block-ignore-begin,unclosed-block-ignore-end
|
|
experimental_apply_changes_via_bot: 1
|
|
use_sarif: ${{ (!github.event.pull_request || (github.event.pull_request.head.repo.full_name == github.repository)) && 1 }}
|
|
check_extra_dictionaries: ""
|
|
dictionary_source_prefixes: >
|
|
{
|
|
"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20241114/dictionaries/"
|
|
}
|
|
extra_dictionaries: |
|
|
cspell:software-terms/softwareTerms.txt
|
|
cspell:cpp/stdlib-cpp.txt
|
|
cspell:filetypes/filetypes.txt
|
|
cspell:cpp/stdlib-c.txt
|
|
cspell:lorem-ipsum/dictionary.txt
|
|
cspell:python/python/python-lib.txt
|
|
cspell:php/php.txt
|
|
cspell:fullstack/fullstack.txt
|
|
cspell:dotnet/dotnet.txt
|
|
cspell:swift/swift.txt
|
|
cspell:node/node.txt
|
|
cspell:dart/dart.txt
|
|
cspell:django/django.txt
|
|
cspell:python/python/python.txt
|
|
cspell:powershell/powershell.txt
|
|
cspell:npm/npm.txt
|
|
cspell:golang/go.txt
|
|
cspell:cpp/compiler-msvc.txt
|
|
cspell:csharp/csharp.txt
|
|
cspell:html/html.txt
|
|
cspell:java/java.txt
|
|
cspell:aws/aws.txt
|
|
cspell:typescript/typescript.txt
|
|
cspell:cpp/lang-keywords.txt
|
|
cspell:python/common/extra.txt
|
|
cspell:scala/scala.txt
|
|
cspell:shell/shell-all-words.txt
|
|
cspell:css/css.txt
|
|
cspell:r/r.txt
|
|
cspell:java/java-terms.txt
|
|
cspell:cpp/stdlib-cerrno.txt
|
|
cspell:k8s/k8s.txt
|
|
|
|
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:
|
|
actions: read
|
|
contents: write
|
|
if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push'
|
|
steps:
|
|
- name: comment
|
|
uses: check-spelling/check-spelling@v0.0.24
|
|
with:
|
|
config: .github/actions/spell-check
|
|
checkout: true
|
|
spell_check_this: microsoft/PowerToys@main
|
|
task: ${{ needs.spelling.outputs.followup }}
|
|
|
|
comment-pr:
|
|
name: Report (PR)
|
|
# If you workflow isn't running on pull_request*, you can remove this job
|
|
runs-on: ubuntu-latest
|
|
needs: spelling
|
|
permissions:
|
|
actions: read
|
|
contents: read
|
|
pull-requests: write
|
|
if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
|
|
steps:
|
|
- name: comment
|
|
uses: check-spelling/check-spelling@v0.0.24
|
|
with:
|
|
config: .github/actions/spell-check
|
|
checkout: true
|
|
spell_check_this: check-spelling/spell-check-this@prerelease
|
|
task: ${{ needs.spelling.outputs.followup }}
|
|
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') &&
|
|
contains(github.event.comment.body, 'https://')
|
|
}}
|
|
concurrency:
|
|
group: spelling-update-${{ github.event.issue.number }}
|
|
cancel-in-progress: false
|
|
steps:
|
|
- name: apply spelling updates
|
|
uses: check-spelling/check-spelling@v0.0.24
|
|
with:
|
|
experimental_apply_changes_via_bot: ${{ github.repository_owner != 'microsoft' && 1 }}
|
|
checkout: true
|
|
ssh_key: "${{ secrets.CHECK_SPELLING }}"
|