···11-# Mardown Links
22-\]\([\S\s]+?\)
33-44-# Markdown Code Blocks
55-`{1,3}[\s\S]+?`{1,3}
66-77-# URLs
88-(https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|www\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\.[^\s]{2,}|https?:\/\/(?:www\.|(?!www))[a-zA-Z0-9]+\.[^\s]{2,}|www\.[a-zA-Z0-9]+\.[^\s]{2,})
99-1010-# Words after hyphen written lowercase
1111-(?<= -)(\p{Ll})+
1212-1313-# First letter thick
1414-\*\*(\S+)\*\*(\S+)
-195
.github/workflows/spell-checker.yml
···11-name: Check Spelling
22-33-# Comment management is handled through a secondary job, for details see:
44-# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
55-#
66-# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
77-# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
88-# it needs `contents: write` in order to add a comment.
99-#
1010-# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
1111-# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
1212-# it needs `pull-requests: write` in order to manipulate those comments.
1313-1414-# Updating pull request branches is managed via comment handling.
1515-# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
1616-#
1717-# These elements work together to make it happen:
1818-#
1919-# `on.issue_comment`
2020-# This event listens to comments by users asking to update the metadata.
2121-#
2222-# `jobs.update`
2323-# This job runs in response to an issue_comment and will push a new commit
2424-# to update the spelling metadata.
2525-#
2626-# `with.experimental_apply_changes_via_bot`
2727-# Tells the action to support and generate messages that enable it
2828-# to make a commit to update the spelling metadata.
2929-#
3030-# `with.ssh_key`
3131-# In order to trigger workflows when the commit is made, you can provide a
3232-# secret (typically, a write-enabled github deploy key).
3333-#
3434-# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
3535-3636-# Sarif reporting
3737-#
3838-# Access to Sarif reports is generally restricted (by GitHub) to members of the repository.
3939-#
4040-# Requires enabling `security-events: write`
4141-# and configuring the action with `use_sarif: 1`
4242-#
4343-# For information on the feature, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Sarif-output
4444-4545-# Minimal workflow structure:
4646-#
4747-# on:
4848-# push:
4949-# ...
5050-# pull_request_target:
5151-# ...
5252-# jobs:
5353-# # you only want the spelling job, all others should be omitted
5454-# spelling:
5555-# # remove `security-events: write` and `use_sarif: 1`
5656-# # remove `experimental_apply_changes_via_bot: 1`
5757-# ... otherwise adjust the `with:` as you wish
5858-5959-on:
6060- push:
6161- branches:
6262- - "**"
6363- tags-ignore:
6464- - "**"
6565- pull_request_target:
6666- branches:
6767- - "**"
6868- types:
6969- - "opened"
7070- - "reopened"
7171- - "synchronize"
7272- issue_comment:
7373- types:
7474- - "created"
7575-7676-jobs:
7777- spelling:
7878- name: Check Spelling
7979- permissions:
8080- contents: read
8181- pull-requests: read
8282- actions: read
8383- security-events: write
8484- outputs:
8585- followup: ${{ steps.spelling.outputs.followup }}
8686- runs-on: ubuntu-latest
8787- if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}
8888- concurrency:
8989- group: spelling-${{ github.event.pull_request.number || github.ref }}
9090- # note: If you use only_check_changed_files, you do not want cancel-in-progress
9191- cancel-in-progress: true
9292- steps:
9393- - name: check-spelling
9494- id: spelling
9595- uses: check-spelling/check-spelling@main
9696- with:
9797- suppress_push_for_open_pull_request: ${{ github.actor != 'dependabot[bot]' && 1 }}
9898- checkout: true
9999- check_file_names: 1
100100- spell_check_this: check-spelling/spell-check-this@prerelease
101101- post_comment: 0
102102- use_magic_file: 1
103103- report-timing: 1
104104- warnings: bad-regex,binary-file,deprecated-feature,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
105105- experimental_apply_changes_via_bot: 1
106106- use_sarif: ${{ (!github.event.pull_request || (github.event.pull_request.head.repo.full_name == github.repository)) && 1 }}
107107- extra_dictionary_limit: 50
108108- extra_dictionaries: cspell:software-terms/dict/softwareTerms.txt
109109- cspell:de_DE/src/hunspell/index.dic
110110- cspell:de_AT/src/hunspell/index.dic
111111-112112- cspell:node/dict/node.txt
113113- cspell:filetypes/filetypes.txt
114114- cspell:php/dict/php.txt
115115- cspell:python/src/python/python-lib.txt
116116- cspell:fullstack/dict/fullstack.txt
117117- cspell:r/src/r.txt
118118- cspell:aws/aws.txt
119119- cspell:css/dict/css.txt
120120- cspell:cpp/src/stdlib-c.txt
121121- cspell:npm/dict/npm.txt
122122- cspell:html/dict/html.txt
123123- cspell:csharp/csharp.txt
124124- cspell:k8s/dict/k8s.txt
125125- cspell:dotnet/dict/dotnet.txt
126126- cspell:cpp/src/lang-keywords.txt
127127- cspell:python/src/python/python.txt
128128- cspell:django/dict/django.txt
129129- cspell:typescript/dict/typescript.txt
130130- cspell:golang/dict/go.txt
131131- cspell:docker/src/docker-words.txt
132132-133133- ignore-pattern: "[^'a-zäöüßA-ZÄÖÜ]"
134134- upper-pattern: "[A-ZÄÖÜ]"
135135- lower-pattern: "[a-zäöüß]"
136136- not-lower-pattern: "[^a-zäöüß]"
137137- not-upper-or-lower-pattern: "[^A-ZÄÖÜa-zäöüß]"
138138- punctuation-pattern: "'"
139139-140140- comment-push:
141141- name: Report (Push)
142142- # If your workflow isn't running on push, you can remove this job
143143- runs-on: ubuntu-latest
144144- needs: spelling
145145- permissions:
146146- contents: write
147147- if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push'
148148- steps:
149149- - name: comment
150150- uses: check-spelling/check-spelling@main
151151- with:
152152- checkout: true
153153- spell_check_this: check-spelling/spell-check-this@prerelease
154154- task: ${{ needs.spelling.outputs.followup }}
155155-156156- comment-pr:
157157- name: Report (PR)
158158- # If you workflow isn't running on pull_request*, you can remove this job
159159- runs-on: ubuntu-latest
160160- needs: spelling
161161- permissions:
162162- contents: read
163163- pull-requests: write
164164- if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
165165- steps:
166166- - name: comment
167167- uses: check-spelling/check-spelling@main
168168- with:
169169- checkout: true
170170- spell_check_this: check-spelling/spell-check-this@prerelease
171171- task: ${{ needs.spelling.outputs.followup }}
172172- experimental_apply_changes_via_bot: 1
173173-174174- update:
175175- name: Update PR
176176- permissions:
177177- contents: write
178178- pull-requests: write
179179- actions: read
180180- runs-on: ubuntu-latest
181181- if: ${{
182182- github.event_name == 'issue_comment' &&
183183- github.event.issue.pull_request &&
184184- contains(github.event.comment.body, '@check-spelling-bot apply')
185185- }}
186186- concurrency:
187187- group: spelling-update-${{ github.event.issue.number }}
188188- cancel-in-progress: false
189189- steps:
190190- - name: apply spelling updates
191191- uses: check-spelling/check-spelling@main
192192- with:
193193- experimental_apply_changes_via_bot: 1
194194- checkout: true
195195- ssh_key: "${{ secrets.CHECK_SPELLING }}"