Skip to content

Commit 0f8d794

Browse files
Copilotpelikhan
andauthored
docs: replace low-level cron with fuzzy scheduling in documentation (#30871)
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/b8ce651c-48d1-47d2-afa9-87f74ef02496 Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
1 parent bf10197 commit 0f8d794

11 files changed

Lines changed: 23 additions & 30 deletions

File tree

docs/src/content/docs/examples/scheduled.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Scheduled Workflows
3-
description: Workflows that run automatically on a schedule using cron expressions - daily reports, weekly research, and continuous improvement patterns
3+
description: Workflows that run automatically on a schedule using fuzzy schedules - daily reports, weekly research, and continuous improvement patterns
44
sidebar:
55
order: 1
66
---
77

8-
Scheduled workflows run automatically at specified times using cron expressions. They're perfect for recurring tasks like daily status updates, weekly research reports, continuous code improvements, and automated maintenance.
8+
Scheduled workflows run automatically at specified times using fuzzy schedule expressions. They're perfect for recurring tasks like daily status updates, weekly research reports, continuous code improvements, and automated maintenance.
99

1010
## When to Use Scheduled Workflows
1111

docs/src/content/docs/patterns/batch-ops.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ Split work into fixed-size pages using `GITHUB_RUN_NUMBER`. Each run processes o
2525
```aw wrap
2626
---
2727
on:
28-
schedule:
29-
- cron: "0 2 * * 1-5" # Weekdays at 2 AM
28+
schedule: daily on weekdays
3029
workflow_dispatch:
3130

3231
tools:

docs/src/content/docs/patterns/central-repo-ops.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Navigate to your central repository and create a workflow file `.github/workflow
2424
```aw wrap
2525
---
2626
on:
27-
schedule:
28-
- cron: '0 9 * * 1'
27+
schedule: weekly on monday
2928

3029
tools:
3130
github:

docs/src/content/docs/patterns/daily-ops.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ Workflows run on weekday schedules (avoiding weekends) with `workflow_dispatch`
1616
```aw wrap
1717
---
1818
on:
19-
schedule:
20-
- cron: "0 2 * * 1-5" # Weekdays only (no short syntax available)
19+
schedule: daily on weekdays
2120
workflow_dispatch:
2221
---
2322
```

docs/src/content/docs/patterns/project-ops.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ Let's start with a simple agentic workflow that reviews project board state and
8282
```aw wrap
8383
---
8484
on:
85-
schedule:
86-
- cron: "0 14 * * 1"
85+
schedule: weekly on monday
8786
permissions:
8887
contents: read
8988
actions: read

docs/src/content/docs/patterns/research-plan-assign-ops.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ The [`go-fan`](https://github.com/github/gh-aw/blob/main/.github/workflows/go-fa
2525
---
2626
name: Go Fan
2727
on:
28-
schedule:
29-
- cron: "0 7 * * 1-5"
28+
schedule: daily on weekdays
3029
workflow_dispatch:
3130
engine: claude
3231
safe-outputs:

docs/src/content/docs/patterns/workqueue-ops.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ Create one sub-issue per work item. The agent queries open sub-issues of a paren
5252
```aw wrap
5353
---
5454
on:
55-
schedule:
56-
- cron: "0 * * * *" # Every hour
55+
schedule: hourly
5756
workflow_dispatch:
5857

5958
tools:
@@ -90,8 +89,7 @@ Store queue state as a JSON file in [cache-memory](/gh-aw/reference/cache-memory
9089
```aw wrap
9190
---
9291
on:
93-
schedule:
94-
- cron: "0 6 * * 1-5" # Weekdays at 6 AM
92+
schedule: daily on weekdays
9593
workflow_dispatch:
9694

9795
tools:
@@ -138,8 +136,7 @@ Use a GitHub Discussion to track pending work items. Unresolved replies represen
138136
```aw wrap
139137
---
140138
on:
141-
schedule:
142-
- cron: "0 8 * * *" # Daily at 8 AM
139+
schedule: daily
143140
workflow_dispatch:
144141
145142
tools:

docs/src/content/docs/reference/cross-repository.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,7 @@ A scheduled workflow that automatically pushes changes to open pull-request bran
256256
```aw wrap
257257
---
258258
on:
259-
schedule:
260-
- cron: "0 * * * *"
259+
schedule: hourly
261260

262261
checkout:
263262
- repository: org/target-repo

docs/src/content/docs/reference/faq.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,15 +146,21 @@ This enables reusable tool configurations, network settings, and permissions acr
146146

147147
### Can I run workflows on a schedule?
148148

149-
Yes, use cron expressions in the `on:` trigger:
149+
Yes, use fuzzy schedule expressions in the `on:` trigger (recommended):
150+
151+
```yaml wrap
152+
on: weekly on monday # Automatically scattered to avoid load spikes
153+
```
154+
155+
Or use standard cron syntax for fixed times:
150156

151157
```yaml wrap
152158
on:
153159
schedule:
154160
- cron: "0 9 * * MON" # Every Monday at 9am UTC
155161
```
156162

157-
See [Schedule Syntax](/gh-aw/reference/schedule-syntax/) for cron expression reference.
163+
See [Schedule Syntax](/gh-aw/reference/schedule-syntax/) for all supported formats.
158164

159165
### Can I run workflows conditionally?
160166

docs/src/content/docs/reference/playwright.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,7 @@ Playwright includes three browser engines: **Chromium** (Chrome/Edge, most commo
139139
```aw wrap
140140
---
141141
on:
142-
schedule:
143-
- cron: "0 9 * * *" # Daily at 9 AM
142+
schedule: daily
144143
145144
tools:
146145
playwright:

0 commit comments

Comments
 (0)