Skip to content

Commit 4d59d36

Browse files
authored
Update doc for CronSchedule (#628)
1 parent 6a95b01 commit 4d59d36

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

internal/client.go

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,10 +282,12 @@ type (
282282
RetryPolicy *RetryPolicy
283283

284284
// CronSchedule - Optional cron schedule for workflow. If a cron schedule is specified, the workflow will run
285-
// as a cron based on the schedule. The scheduling will be based on Cadence server's timezone. Schedule for next
286-
// run only happen when the current run is completed/failed/timedout. So if the workflow is still running while
287-
// next schedule is due, then it will skip that schedule. Cron workflow never stop until it is terminated or
288-
// cancelled (by returning cadence.CanceledError). The cron spec is as following:
285+
// as a cron based on the schedule. The scheduling will be based on UTC time. Schedule for next run only happen
286+
// after the current run is completed/failed/timeout. If a RetryPolicy is also supplied, and the workflow failed
287+
// or timeout, the workflow will be retried based on the retry policy. While the workflow is retrying, it won't
288+
// schedule its next run. If next schedule is due while workflow is running (or retrying), then it will skip that
289+
// schedule. Cron workflow will not stop until it is terminated or cancelled (by returning cadence.CanceledError).
290+
// The cron spec is as following:
289291
// ┌───────────── minute (0 - 59)
290292
// │ ┌───────────── hour (0 - 23)
291293
// │ │ ┌───────────── day of the month (1 - 31)

internal/workflow.go

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,12 @@ type (
182182
RetryPolicy *RetryPolicy
183183

184184
// CronSchedule - Optional cron schedule for workflow. If a cron schedule is specified, the workflow will run
185-
// as a cron based on the schedule. The scheduling will be based on Cadence server's timezone. Schedule for next
186-
// run only happen when the current run is completed/failed/timedout. So if the workflow is still running while
187-
// next schedule is due, then it will skip that schedule. Cron workflow never stop until it is terminated or
188-
// cancelled (by returning cadence.CanceledError). The cron spec is as following:
185+
// as a cron based on the schedule. The scheduling will be based on UTC time. Schedule for next run only happen
186+
// after the current run is completed/failed/timeout. If a RetryPolicy is also supplied, and the workflow failed
187+
// or timeout, the workflow will be retried based on the retry policy. While the workflow is retrying, it won't
188+
// schedule its next run. If next schedule is due while workflow is running (or retrying), then it will skip that
189+
// schedule. Cron workflow will not stop until it is terminated or cancelled (by returning cadence.CanceledError).
190+
// The cron spec is as following:
189191
// ┌───────────── minute (0 - 59)
190192
// │ ┌───────────── hour (0 - 23)
191193
// │ │ ┌───────────── day of the month (1 - 31)

0 commit comments

Comments
 (0)