Getting started
Quick start
Install the app, add one comment, push. Setup takes a few minutes; the first run comes at its next scheduled time.
1. Install the GitHub App
Install Cronkick and pick the repositories it can see. You can change the list later in your GitHub settings.
2. Add the marker
In the workflow file, add workflow_dispatch: under on:, and a # cronkick comment with your cron right below it.
on:
workflow_dispatch:
# cronkick: "0 3 * * *"
jobs:
nightly:
runs-on: ubuntu-latest
steps:
- run: echo "on time"Already using schedule:?
Remove the schedule: block in the same commit, or GitHub runs the workflow a second time, late. See Moving from schedule:.
3. Push to the default branch
Cronkick reads the file within seconds. Open your dashboard: the workflow shows up with its next scheduled time. The example above first runs at the next 03:00 UTC. If something in the workflow would break a dispatched run, it shows Needs a fix with the reason instead.