View on GitHub

check-spelling-docs

Documentation for check-spelling

Onboarding

The easiest way to get started is by following the Quick Start instructions.

If you do this before people create forks of your repository, things should go fairly smoothly.

As of v0.0.21 (but hopefully not the next release), if a user creates a branch from before check-spelling is added, but creates a PR to the repository with check-spelling as configured by spell-check-this in .github/workflows/spelling.yml, check-spelling will run but not find its configuration. Because it won't find its configuration, it will almost certainly get somewhat upset with users and lead them to be at least a little bit confused.

Workarounds

v0.0.21

There's a workaround included in check-spelling/spell-check-this@prerelease's .github/actions/spelling/advice.md file.

Happily, the spell_check_this field which is used for when check-spelling doesn't have configuration can be used to cover this case.

Instead of having that field point to check-spelling/spell-check-this@prerelease, it can be changed to point to your own repository's primary branch (one where you're adding check-spelling).

Thus, if your repository is octocat/Spoon-Knife and you're adding check-spelling to the main branch, you could point to octocat/Spoon-Knife@main:

  uses: check-spelling/check-spelling@v0.0.21 
  with:
    # ...
    spell_check_this: octocat/Spoon-Knife@main

The active assumption here is that any PRs to branches that are created after check-spelling is added to octocat/Spoon-Knife@main will be created based on commits that already include check-spelling, and thus the spell_check_this codepath won't be used.