View on GitHub

check-spelling-docs

Documentation for check-spelling

Suggest commit after expect update

Included in v0.0.20

Currently the flow is

  1. User creates a PR.
  2. This triggers a workflow which could add a ❌ status.
  3. User uses Update expect list which triggers an additional commit.
  4. This doesn't trigger a new workflow run because GitHub doesn't want to risk triggering a loop.

Thus, at this point it's likely that spell check would pass "now", but doesn't currently have a ✅ status.

Problem

At this point, the check has most recently ❌ failed, and there's a new commit without checks.

If your repository has a mandatory check for this action, it would refuse to merge.

Workaround

Users can just edit the expect file and add a blank line.

Plan

The action will add a comment suggesting adding that blank line to trigger a new check pass (until a better approach is added).


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