⏩ Upgrading
- 🏷️ You can just change your workflow tags/references to this release, but some features require updates to the workflow (including collapsing the most recent comment if the current check passes ✅ ); please consider applying the workflow from check-spelling/spell-check-this@prerelease. (The link will change shortly after this release is made.)
- You will want to copy over the
with:
elements you're using (into each place thatuses: check-spelling/check-spelling
).
- You will want to copy over the
- 🐍 If you see complaints about
b'...
orr'...
or similar, you probably should add something like this (from https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) topatterns.txt
(you can select the subset that you actually use, which may be justb
,r
, andf
):# Python stringprefix / binaryprefix \b(?:B|BR|Br|F|FR|Fr|R|RB|RF|Rb|Rf|U|UR|Ur|b|bR|br|f|fR|fr|r|rB|rF|rb|rf|u|uR|ur)'
🐣 Breaking Changes
- 📝 Line ending excluded from parsing for patterns
- 🗜️ Artifacts are now proactively zipped -- if you have a custom workflow that is consuming the output from this action, you will need to adjust it to unzip the
artifact.zip
file. This was implemented because at times the upload-artifact action needed to retry its uploads which was unreasonably slow for the files it was uploading.
✨ New features
- 💨 Faster processing (10x faster for larger repositories)
- 🦺 Security Polling
- 🔒 Restricted Permissions
- 🔑 Update with deploy key
- 🔍 Check filenames and paths
- 📏 Configurable file size limits
- 🥅 Limit the number of times an unknown word is reported
- 🚩 User visible warning codes
- 🚥 Treat specific errors as warnings
- 💬 Disclaimer about missing status
- 🗜️ Automatically truncate comment
- 🤫 Suppress push comment for open PRs
- 🤫 Suppress commenting
- 📚 Area dictionaries (including streetsidesoftware/cspell-dicts)
- 🧙 Suggest Area Dictionaries
- 🚫 Forbidden patterns
- 🖊️ Behavior change: Patterns masking character
- 🤾♂️ Play nice with
@dependabot
- 🤝 Support easier to understand filenames
- 👡 Easier bootstrapping
- 🏠 Run locally with nektos/act should work
- 🧪 Perl module testing
- 🔗 Improve merge conflict handling using checkout-merge
- 🔏 Comment on locked PRs
📝 Documentation
- 🏇 Concurrency
- 🧑🤝🧑 Duplicate word detection
☁️ Features that may have less need due to other improvements
💅 Minor polish
- 🔍 Added problem matchers for
curl
,git
, andjq
. - 💬 Pretty comment references
- 🔐 Comment references work for private repositories
🐜 Bug fixes
- 🧹 #23 Collapse older check comments
- 🗣️ #16 allow comments in
dictionary
,expect
, andallow
files (note that various components may drop comments fromexpect
) - 😊 #12 remove duplicated word (there's now code to catch this for everyone going forward)
- 📐 Fix handling of
we'd
(due to changing the minimum word length from 2 to 3,we
no longer was a base word, butwe'd
wanted to stem to it) - 📃 Fix some handling of case folding issues (there are still some left)
🗑️ Cleanup
- 🐳 Docker file content has been removed (this legacy content hasn't been used for a long time) -- to run locally, use nektos/act
- ⬢node.js trampoline has been removed (this legacy content hasn't been used for a long time) in favor of composite actions
- 🐎 Discontinued use of
parallel
-- it's too inconsistent andxargs -P
is sufficient and sufficiently portable to satisfy the requirements of check-spelling.