Sign inInstall
Guides / The marker

Guides

The marker

The one-line comment that tells Cronkick when to run a workflow.

Syntax

# cronkick: "<cron>" [tz=<IANA time zone>]
cronThe usual 5 fields: minute, hour, day of month, month, day of week. In double quotes.
tz=Optional. Any IANA time zone, such as Europe/Berlin or America/New_York. Without it, the cron runs in UTC.

The marker is a YAML comment, so GitHub ignores it. Put it anywhere in the file; the convention is its own line right under workflow_dispatch:.

Examples

Weekdays at 09:00 Berlin time
on:
  workflow_dispatch:
  # cronkick: "0 9 * * 1-5" tz=Europe/Berlin
Every 15 minutes
on:
  workflow_dispatch:
  # cronkick: "*/15 * * * *"

Several schedules

Add one marker line per schedule. Each line counts as one schedule on your plan. Schedules due at the same moment trigger the workflow once.

on:
  workflow_dispatch:
  # cronkick: "0 6 * * 1-5" tz=America/New_York
  # cronkick: "0 12 * * 6,0" tz=America/New_York

Daylight saving time

With a tz=, times follow the local clock. When the clock skips an hour, a run in the skipped hour fires once, an hour later on the new clock (02:30 becomes 03:30). When the clock repeats an hour, it runs once.