View on GitHub

check-spelling-docs

Documentation for check-spelling

Diagnose failed checkouts

Background

checking out a repository is actually a lot of work, in fact, GitHub's actions/checkout repository is approximately twice as large as check-spelling!

Unfortunately, one of the things that can happen when people try to check out a repository is that it can fail, and it can fail for lots of reasons.

Goal

Ideally, if, when you use check-spelling, the checkout fails, you should be able to get a helpful message explaining what's going wrong with a hint about how to fix it.

If check-spelling can suggest a likely cause and solution, it will.

If it can't, it will suggest looking for a ticket for checkout-failed-unknown-cause and possibly filing one if you can't find a relevant issue. This feature will be improved in the future as other causes are analyzed.


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