View on GitHub


Documentation for check-spelling

Frequently Asked Questions

How do I upgrade?

The recommended approach to upgrading is to merge the contents of into your .github directory.

For the workflow, you'll generally want to copy over any settings that you've applied (typically dictionary configuration) and remove any items you've removed.

New releases of check-spelling will add new features, some of which may be enabled by default. But, often, to avoid behavior changes to existing deployments, they require opting in, and thus additional flags via workflow parameters.

The spell-check-this template repository enables some settings which you might not want, in some ways it's a showcase of what check-spelling can do (e.g. check PR summary and descriptions, or even commit messages).

How do I get comments to collapse?

There are lots of reasons comments won't collapse, but the fix is generally to refresh your workflow.

When you push to a Pull Request, the workflow that matters is generally the base branch (although, also the Pull Request's head branch).

When you comment on a Pull Request, the workflow that matters is the one for your default branch.

Why can't I see the ๐Ÿ‘ผ SARIF report?

Reports for some repositories will have an entry like:

See the ๐Ÿ“‚ files view, the ๐Ÿ“œaction log or ๐Ÿ‘ผ SARIF report for details.

Users without write access to the repository will probably not be able to see the ๐Ÿ‘ผ SARIF report, and will instead see a 404 page.

This relates to the fact that SARIF was designed for reporting results from security scanners, as such GitHub restricts who has access to the reports. For more information, see SARIF output visibility.

FAQ | Showcase | Event descriptions | Configuration information | Known Issues | Possible features | Deprecations | Release notes | Helpful scripts