View on GitHub

check-spelling-docs

Documentation for check-spelling

Breaking change: Dropping support for on: schedule

History

The original workaround for not having permissions for pull requests from forks was to use the schedule event.

That was supplanted with the introduction of support for pull_request_target.

There was other contemplated work Limit schedule branches for the feature, but pull_request_target has proven to be considerably cleaner than schedule and at this point, schedule is mostly abandoned.

Plan

v0.0.22

Will probably be the last version supporting schedule.

It will include a warning linking to this item.

v0.0.23

(or whatever comes after 0.0.22)

Will probably not support schedule.

Migration

In most cases you should be able to refresh your workflow using https://raw.githubusercontent.com/check-spelling/spell-check-this/main/.github/workflows/spelling.yml adopting a standard on: pull_request_target.

Feedback

If you're actually using schedule, please check for an issue. If there is one, please add your use case to it, if there isn't one, please open an issue and explain why you're using schedule instead of push/pull_request/pull_request_target.


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