magic file enables check-spelling to automatically recognize more files to exclude. It has been pretty reliable/helpful.
Migrating
When you upgrade, if there are files that magic file detects as worthy of excluding, it will suggest adding them to excludes. If they turn out to be files that shouldn't be excluded, you can add use_magic_file: 0 to turn it off (and please file an issue with a sample showing why the files were falsely suggested for exclusion).
If you had previously set use_magic_file: 1, you can remove that setting, as that's now the new default. (You can also leave the value set, it's basically harmless, but it is now superfluous.)
cache-dictionaries has been removed
... along with all other caching -- check-spelling should be faster now than in previous versions, so the lack of this caching shouldn't be a concern.
Migrating
If you're using this setting, just remove it (you'll get a warning from GitHub when the workflow runs).
check-spelling now requires actions/upload-artifact@v4 / actions/checkout@v4
It is quite possible that GHES does not support these yet.
Migrating
Users of GHES instances that don't have access to those actions should not upgrade until they're available.
Comment block before forbidden-patterns is now shown when patterns are tripped
When a forbidden-pattern matches content, lines immediately preceding it that start with # will be shown in the GitHub Step Summary.
Migrating
You should change such comments to start with # (a single # that isn't followed by a space is assumed to be a commented out pattern). And you should ensure that comments are easy for readers to understand.
For example, in spell-check-this, lines that used to say # s.b. ... have been changed to # Should be ...
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
To accept these unrecognized words as correct,
you could run the following commands
... in a clone of the [git@github.com:mondoohq/installer.git](https://github.com/mondoohq/installer.git) repository
on the `dependabot/github_actions/check-spelling/check-spelling-0.0.23` branch ([:information_source: how do I use this?](
https://docs.check-spelling.dev/Accepting-Suggestions)):
``` sh
curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.23/apply.pl' |
perl - 'https://github.com/mondoohq/installer/actions/runs/11561286251/attempts/1'
```
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary
This includes both **expected items** (687) from .github/actions/spelling/expect.txt and **unrecognized words** (4)
Dictionary | Entries | Covers | Uniquely
-|-|-|-
[cspell:node/dict/node.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/node/dict/node.txt)|891|2||
[cspell:golang/dict/go.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/golang/dict/go.txt)|2099|2||
[cspell:fullstack/dict/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/fullstack/dict/fullstack.txt)|419|1|1|
[cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|1|1|
[cspell:docker/src/docker-words.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/docker/src/docker-words.txt)|27|1||
Consider adding them (in `.github/workflows/spell-check.yaml`) in `jobs:`/`spelling:` for `uses: check-spelling/check-spelling@v0.0.23` in its `with`:
``` yml
with:
extra_dictionaries: |
cspell:node/dict/node.txt
cspell:golang/dict/go.txt
cspell:fullstack/dict/fullstack.txt
cspell:python/src/python/python-lib.txt
cspell:docker/src/docker-words.txt
```
To stop checking additional dictionaries, add (in `.github/workflows/spell-check.yaml`) for `uses: check-spelling/check-spelling@v0.0.23` in its `with`:
``` yml
check_extra_dictionaries: ''
```
Errors (2)
#### See the [:open_file_folder: files](https://github.com/mondoohq/installer/pull/485/files/) view, the [:scroll:action log](https://github.com/mondoohq/installer/actions/runs/11561286251/job/32179949655#step:4:1), or [:memo: job summary](https://github.com/mondoohq/installer/actions/runs/11561286251/attempts/1#summary-32179949655) for details.
[:x: Errors](https://docs.check-spelling.dev/Event-descriptions) | Count
-|-
[:x: forbidden-pattern](https://docs.check-spelling.dev/Event-descriptions#forbidden-pattern) | 2
[:warning: no-newline-at-eof](https://docs.check-spelling.dev/Event-descriptions#no-newline-at-eof) | 1
See [:x: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
If the flagged items are false positives
If items relate to a ...
- binary file (or some other file you wouldn't want to check at all).
Please add a file path to the `excludes.txt` file matching the containing file.
File paths are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude README.md (on whichever branch you're using).
- well-formed pattern.
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.
Patterns are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary
This includes both **expected items** (691) from .github/actions/spelling/expect.txt and **unrecognized words** (0)
Dictionary | Entries | Covers | Uniquely
-|-|-|-
[cspell:node/dict/node.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/node/dict/node.txt)|891|2||
[cspell:golang/dict/go.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/golang/dict/go.txt)|2099|2||
[cspell:fullstack/dict/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/fullstack/dict/fullstack.txt)|419|1|1|
[cspell:python/src/python/python-lib.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/python/src/python/python-lib.txt)|2417|1|1|
[cspell:docker/src/docker-words.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/docker/src/docker-words.txt)|27|1||
Consider adding them (in `.github/workflows/spell-check.yaml`) in `jobs:`/`spelling:` for `uses: check-spelling/check-spelling@v0.0.23` in its `with`:
``` yml
with:
extra_dictionaries: |
cspell:node/dict/node.txt
cspell:golang/dict/go.txt
cspell:fullstack/dict/fullstack.txt
cspell:python/src/python/python-lib.txt
cspell:docker/src/docker-words.txt
```
To stop checking additional dictionaries, add (in `.github/workflows/spell-check.yaml`) for `uses: check-spelling/check-spelling@v0.0.23` in its `with`:
``` yml
check_extra_dictionaries: ''
```
Forbidden patterns :no_good: (1)
In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.
These forbidden patterns matched content:
#### s.b. VS Code
```
\bVSCode\b
```
If the flagged items are false positives
If items relate to a ...
- binary file (or some other file you wouldn't want to check at all).
Please add a file path to the `excludes.txt` file matching the containing file.
File paths are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude README.md (on whichever branch you're using).
- well-formed pattern.
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.
Patterns are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
Bumps check-spelling/check-spelling from 0.0.22 to 0.0.23.
Release notes
Sourced from check-spelling/check-spelling's releases.
... (truncated)
Commits
2c9e4a8
action: Release v0.0.238da92f1
action: Load actions on demand6494dc2
action: Improve missing merge head handling41422d3
test: Download gh if it is ancient21dd9f4
apt-get: Limit ubuntu apt package database51d0efe
unknown-words: Check expect files in clean envb83dbf1
UnknownWordSplitter: Put all directories into a sandbox0851aa9
unknown-words: Avoid usingtemp
env var637add0
Split dictionary-not-found errors4825b2f
tests: Add FlakyServer.tDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show