Check Spelling

Version updated for https://github.com/check-spelling/check-spelling to version v0.0.25.

• This action is used across all versions by 2,556 repositories.

Go to the GitHub Marketplace to find the latest changes.

Release notes

⏩ Upgrading

• 🏷️ Test first on a branch by changing your workflow tags/references to this release. See 🐣 Breaking Changes for how to adapt your workflow.
• 🐛 See Known Issues for known issues

🐣 Breaking Changes

• Code Scanning action requires a Code Scanning Ruleset If you use SARIF reporting, then instead of the workflow yielding an :x: when it fails, it will rely on github-advanced-security 🤖 to report the failure. You will need to adjust your checks for PRs.
• Dropping support for on: schedule
• Dropping support for whitelist.txt and advice.txt
• Dropping support for out of tree project files

✨ New Features

• Check submodules using submodules
• Provide instructions for when only_check_changed_files finds unrecognized words
• Support unknown_file_word_limit to limit the number of times a path in a filename is reported when using check_file_names
• Suggest checkout: true for new missing-checkout error case
• Suggest ignoring files that trigger single-line-file

Dictionaries

• Fix fallback-dictionary-not-found handling

Hunspell dictionaries

• Fix support for .dic/.aff dictionaries by installing hunspell as needed (#79 / #90)
• Ensure that Spanish works (a consumer is using this, so it should work reliably)

Fixes

• macOS: Consistently use check-spelling dictionary instead of looking at the system dictionary
• Fix check_for_newline_at_eof for allow.txt
• Improve handling of inputs.ignored events
• Fix inputs.debug handling
• Fix merge instructions order
• Fix pattern for validating expect entries
• Fix noisy-file-list handling
• Fix 504 handling for only_check_changed_files when unshallowing
• Restore comment (#) support for expect files
• Include last character in token-is-substring warning

Improvements

• Line ending detection
• RSQM handling
• Dictionary download times by skipping delays for 30x redirects
• Excludes paths generation
• Error handling of various components
• Documentation links
• GitHub error detection patterns for when check-spelling has bugs
• Handling of We'd

Messages

• Improve use of `s
  • Remove them from Line for candidate-pattern
  • Add them with better escaping for more user content
• Treat ignored-expect-variant as a warning

SARIF

• Switch to talking to /code-scanning/analysis directly
• Properly encode # in filenames
• Stop trying to publish SARIF for commits from other repositories
• Use note severity for no-files-to-check
• Support defaultConfiguration.level when problem.severity is absent
• Add additional fields
• Only include used rules

Candidate patterns

• Suggest using # to suppress candidates (you can do this for forbidden patterns too, but this version won’t suggest that)

Apply

• Improve error handling

Summary Tables

• List all present event classes at the top level
• Support cross repository pull requests

Checkout

• Suppress useless message about default branch
• Add failed checkout diagnostics
• Limit checkout credentials

Testing

• Replace jd with Test::More::is_deeply
• Improve test suite and test coverage
• Work to consistently order output

Upgrade components

• checkout-merge@v0.0.7
• gh-program-downloader@v0.0.4

🐛 Known Issues

• act as of v0.2.77 is not supported with checkout: true (there’s a PR to act to fix this)

Full Changelog

Full Changelog: https://github.com/check-spelling/check-spelling/compare/v0.0.24...v0.0.25

• check-spelling
• GitHub Actions