[wrangler] Add schedule property to Workflow bindings for cron-based triggering#13467
Draft
[wrangler] Add schedule property to Workflow bindings for cron-based triggering#13467
Conversation
…triggering Add optional schedule field to WorkflowBinding and CfWorkflow types, accepting a cron expression string or array of cron expressions. The schedule is validated on config load and sent to the Workflows control plane API on deploy. Configuring schedule on a workflow that references an external script_name is an error. WOR-1221
🦋 Changeset detectedLatest commit: c99475c The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
Codeowners approval required for this PR:
Show detailed file reviewers
|
Contributor
|
✅ All changesets look good |
Contributor
|
I'm Bonk, and I've done a quick review of your PR. This PR adds an optional I found one actionable issue and posted it as a review:
|
create-cloudflare
@cloudflare/kv-asset-handler
miniflare
@cloudflare/pages-shared
@cloudflare/unenv-preset
@cloudflare/vite-plugin
@cloudflare/vitest-pool-workers
@cloudflare/workers-editor-shared
wrangler
commit: |
…iniflare dev path
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes WOR-1221.
Add an optional
schedulefield to Workflow bindings that accepts a cron expression string or array of cron expressions. Onwrangler deploy, the schedule is sent to the Workflows control plane API, enabling automatic triggering of workflow instances on a cron schedule.Changes
schedule?: string | string[]toWorkflowBindingtype andCfWorkflowinterfacevalidateWorkflowBinding— accepts a non-empty string or non-empty array of non-empty strings; errors on wrong type, empty string, empty array, or mixed arrayscheduleto the API payload intriggers/deploy.ts, with an error ifscheduleis configured on a workflow that references an externalscript_name(consistent with howlimitsis handled)Usage
Multiple schedules:
{ "workflows": [ { "binding": "MY_WORKFLOW", "name": "my-workflow", "class_name": "MyWorkflow", "schedule": ["0 9 * * 1", "0 17 * * 5"] } ] }A picture of a cute animal (not mandatory, but encouraged)